eslint-define-config - npm Package Compare versions

Comparing version 1.0.0-alpha.1 to 1.0.0-alpha.2

CHANGELOG.md

 # Next
 
-[diff](https://github.com/Shinigami92/eslint-define-config/compare/1.0.0-alpha.1...main)
+[diff](https://github.com/Shinigami92/eslint-define-config/compare/1.0.0-alpha.2...main)
 
+# 1.0.0-alpha.2
+
+[diff](https://github.com/Shinigami92/eslint-define-config/compare/1.0.0-alpha.1...1.0.0-alpha.2)
+
+- Define basic structure
+
 # 1.0.0-alpha.1
@@ -6,0 +12,0 @@

dist/index.js

@@ -1,4 +0,1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineConfig = void 0;
 /**
@@ -11,7 +8,6 @@ * Define an eslint config.
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/explicit-function-return-type
-function defineConfig(config) {
+export function defineConfig(config) {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return config;
 }
-exports.defineConfig = defineConfig;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUE7Ozs7O0dBS0c7QUFDSCwrSEFBK0g7QUFDL0gsU0FBZ0IsWUFBWSxDQUFDLE1BQVc7SUFDdEMsK0RBQStEO0lBQy9ELE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUM7QUFIRCxvQ0FHQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBc0JBOzs7OztHQUtHO0FBQ0gsK0hBQStIO0FBQy9ILE1BQU0sVUFBVSxZQUFZLENBQUMsTUFBb0I7SUFDL0MsK0RBQStEO0lBQy9ELE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUMifQ==

package.json

 {
   "name": "eslint-define-config",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.2",
   "description": "Provide a defineConfig function for .eslintrc.js files",
@@ -41,2 +41,3 @@ "main": "dist/index.js",
     "eslint-config-prettier": "~8.1.0",
+    "eslint-define-config": "~1.0.0-alpha.1",
     "eslint-plugin-inclusive-language": "~2.1.1",
@@ -43,0 +44,0 @@ "eslint-plugin-jsdoc": "~32.3.0",

README.md

@@ -0,3 +1,50 @@
+<p>
+  <a href="https://www.npmjs.com/package/eslint-define-config" target="_blank">
+    <img alt="NPM package" src="https://img.shields.io/npm/v/eslint-define-config.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/eslint-define-config" target="_blank">
+    <img alt="Downloads" src="https://img.shields.io/npm/dt/eslint-define-config.svg">
+  </a>
+  <a href="https://github.com/Shinigami92/eslint-define-config/actions/workflows/ci.yml">
+    <img alt="Build Status" src="https://github.com/Shinigami92/eslint-define-config/actions/workflows/ci.yml/badge.svg?branch=main">
+  </a>
+  <a href="https://github.com/Shinigami92/eslint-define-config/blob/main/LICENSE">
+    <img alt="License: MIT" src="https://img.shields.io/github/license/Shinigami92/eslint-define-config.svg">
+  </a>
+  <a href="https://prettier.io" target="_blank">
+    <img alt="Code Style: Prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg">
+  </a>
+</p>
+
 # eslint-define-config
 
 Provide a `defineConfig` function for `.eslintrc.js` files.
+
+# Installation
+
+```bash
+# add eslint and eslint-define-config to project’s dev dependencies
+npm install --dev eslint eslint-define-config
+# or
+yarn add --dev eslint eslint-define-config
+```
+
+# Usage
+
+`.eslintrc.js`
+
+```ts
+const { defineConfig } = require('eslint-define-config');
+
+module.exports = defineConfig({
+  root: true,
+  rules: {
+    // rules...
+  }
+});
+```
+
+# Credits
+
+- `Vite` and [Evan You](https://github.com/yyx990803) for the idea
+- [@antfu](https://github.com/antfu) and her [tweet](https://twitter.com/antfu7/status/1365907188338753536)

src/index.ts

@@ -0,2 +1,24 @@
+import type { Env } from './env';
+import type { Overrides } from './overrides';
+import type { ParserOptions } from './parser-options';
+import type { Rules } from './rules';
+import type { Settings } from './settings';
+
 /**
+ *
+ */
+export interface EslintConfig {
+  root?: boolean;
+  ignorePatterns?: string[];
+  env?: Env;
+  extends?: string[];
+  parser?: string;
+  parserOptions?: ParserOptions;
+  plugins?: string[];
+  rules?: Rules;
+  overrides?: Overrides;
+  settings?: Settings;
+}
+
+/**
  * Define an eslint config.
@@ -8,5 +30,5 @@ *
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/explicit-function-return-type
-export function defineConfig(config: any) {
+export function defineConfig(config: EslintConfig) {
   // eslint-disable-next-line @typescript-eslint/no-unsafe-return
   return config;
 }

tsconfig.json

 {
   "compilerOptions": {
-    "target": "ES2018",
-    "module": "CommonJS",
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "Node",
     "inlineSourceMap": true,
-    "lib": ["ES2018", "DOM"],
+    "lib": ["ESNext"],
     "outDir": "dist",
-    "moduleResolution": "Node",
     "rootDir": "src",
     "strict": true,
-    "noUncheckedIndexedAccess": true
+    "noUncheckedIndexedAccess": true,
+    "declaration": true
   },
@@ -13,0 +14,0 @@ "include": ["src/**/*"],

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14698

increased by240.15%

Number of package files

41

increased by485.71%

Lines of code

340

increased by729.27%

Number of lines in readme file

51

increased by1175%

Worsened metrics

Dev dependency count

13

increased by8.33%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes