@kouts/eslint-config 1.1.0 → 1.2.0

package/README.md

@@ -25,30 +25,35 @@ export default [
   ...config(),
   {
     // Add custom rules here
-  }
+  },
 ]
 ```
 
 #### Customizing the config
 
-You can customize the config by passing an object to the `config` function:
-
-```javascript
-config({
-  ts: true,
-  vue: true
-  vueVersion: 3
-})
-```
+The configuration comes with default settings that extend the [neostandard config](https://github.com/neostandard/neostandard/tree/main?tab=readme-ov-file#configuration-options) config. You can further customize it by passing an object to the `config` function:
 
-**Available options:**
+**Config settings defaults:**
 
 | Option     | Type       | Description                   | Default |
 | ---------- | ---------- | ----------------------------- | ------- |
 | ts         | `boolean`  | Enable TypeScript support     | `true`  |
+| noJsx      | `boolean`  | No jsx rules will be added    | `true`  |
+| noStyle    | `boolean`  | No style rules will be added  | `true`  |
+| semi       | `boolean`  | No semicilons                 | `false` |
 | vue        | `boolean`  | Enable Vue.js support         | `true`  |
 | vueVersion | `2` or `3` | Specify the version of Vue.js | `3`     |
 
+**Example:**
+
+```javascript
+config({
+  ts: false,
+  vue: true
+  vueVersion: 3
+})
+```
+
 ### Prettier config
 
 Create a `prettier.config.js` file with the following content:

package/dist/index.cjs

@@ -423,6 +423,9 @@ const vue = (options) => {
 
 const config = (options) => {
   const opts = {
+    noJsx: true,
+    noStyle: true,
+    semi: false,
     ts: true,
     vue: true,
     vueVersion: 3,
@@ -449,7 +452,7 @@ const config = (options) => {
     // TypeScript
     ...opts.ts ? typescript : [],
     // Neostandard
-    ...neostandard({ noJsx: true, noStyle: true, semi: false, ts: opts.ts }),
+    ...neostandard(opts),
     {
       name: "kouts/neostandard-overrides",
       rules: {

package/dist/index.d.cts

@@ -1,11 +1,11 @@
 import { Linter } from 'eslint';
+import { NeostandardOptions } from 'neostandard';
 export { plugins } from 'neostandard';
 
 type Options = {
-    ts?: boolean;
     vue?: boolean;
     vueVersion?: 2 | 3;
-};
+} & NeostandardOptions;
 declare const config: (options?: Options) => Linter.Config<Linter.RulesRecord>[];
 
 export { config };

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 import { Linter } from 'eslint';
+import { NeostandardOptions } from 'neostandard';
 export { plugins } from 'neostandard';
 
 type Options = {
-    ts?: boolean;
     vue?: boolean;
     vueVersion?: 2 | 3;
-};
+} & NeostandardOptions;
 declare const config: (options?: Options) => Linter.Config<Linter.RulesRecord>[];
 
 export { config };

package/dist/index.js

@@ -422,6 +422,9 @@ const vue = (options) => {
 
 const config = (options) => {
   const opts = {
+    noJsx: true,
+    noStyle: true,
+    semi: false,
     ts: true,
     vue: true,
     vueVersion: 3,
@@ -448,7 +451,7 @@ const config = (options) => {
     // TypeScript
     ...opts.ts ? typescript : [],
     // Neostandard
-    ...neostandard({ noJsx: true, noStyle: true, semi: false, ts: opts.ts }),
+    ...neostandard(opts),
     {
       name: "kouts/neostandard-overrides",
       rules: {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@kouts/eslint-config",
   "type": "module",
-  "version": "1.1.0",
-  "packageManager": "pnpm@9.7.0",
+  "version": "1.2.0",
+  "packageManager": "pnpm@9.7.1",
   "engines": {
     "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
   },
-  "author": "kouts",
+  "author": "Giannis Koutsaftakis",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/kouts/eslint-config/issues"
@@ -78,7 +78,7 @@
     "prettier": "^3.3.3"
   },
   "devDependencies": {
-    "@types/node": "^22.2.0",
+    "@types/node": "^22.3.0",
     "eslint": "^9.9.0",
     "pkgroll": "^2.4.2",
     "typescript": "^5.5.4"