@robot-inventor/eslint-config 0.1.0 → 0.1.2

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 roboin
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 roboin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,2 +1,81 @@
-# eslint-config
-My ESLint config preset
+# eslint-config
+
+[@Robot-Inventor](https://github.com/Robot-Inventor/)'s ESLint config preset.
+
+## Installation
+
+Until [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint) supports ESLint v9, you need to add the following code to your ``.npmrc`` before installing ``@robot-inventor/eslint-config``. If you didn't add it, you will get peer dependency warnings. See [this issue](https://github.com/typescript-eslint/typescript-eslint/issues/8211#issuecomment-2041466332) for more information.
+
+```ini
+legacy-peer-deps=true
+```
+
+Then, install the package:
+
+```bash
+npm install --save-dev @robot-inventor/eslint-config
+```
+
+## Usage
+
+Add the following to your ``eslint.config.js`` file:
+
+```javascript
+// ESModule
+import { eslintConfig } from "@robot-inventor/eslint-config";
+
+export default eslintConfig;
+```
+
+```javascript
+// CommonJS
+const { eslintConfig } = require("@robot-inventor/eslint-config");
+
+module.exports = eslintConfig;
+```
+
+If you don't need JSDoc rules, you can use the ``eslintConfigNoJSDoc`` instead.
+
+```javascript
+// ESModule
+import { eslintConfigNoJSDoc } from "@robot-inventor/eslint-config";
+
+export default eslintConfigNoJSDoc;
+```
+
+```javascript
+// CommonJS
+const { eslintConfigNoJSDoc } = require("@robot-inventor/eslint-config");
+
+module.exports = eslintConfigNoJSDoc;
+```
+
+You can extend or override the config as needed.
+
+```javascript
+// ESModule
+import { eslintConfig } from "@robot-inventor/eslint-config";
+
+export default [
+    ...eslintConfig,
+    {
+        rules: {
+            // Your rules here
+        }
+    }
+];
+```
+
+```javascript
+// CommonJS
+const { eslintConfig } = require("@robot-inventor/eslint-config");
+
+module.exports = [
+    ...eslintConfig,
+    {
+        rules: {
+            // Your rules here
+        }
+    }
+];
+```

package/dist/cjs/index.js

@@ -11,9 +11,7 @@ const eslint_config_prettier_1 = __importDefault(require("eslint-config-prettier
 const eslintConfigNoJSDoc = typescript_eslint_1.default.config(js_1.default.configs.all, eslint_plugin_jsdoc_1.default.configs["flat/recommended-typescript-error"], eslint_config_prettier_1.default, ...typescript_eslint_1.default.configs.recommendedTypeChecked, {
     languageOptions: {
         parserOptions: {
-            project: true,
-            // @ts-expect-error
-            tsconfigRootDir: import.meta.dirname
+            project: true
         }
     },
     plugins: {

package/dist/cjs/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@robot-inventor/eslint-config",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "My ESLint config preset",
   "type": "commonjs",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "tsc -p . && tsc -p ./tsconfig.cjs.json && tsconfig-to-dual-package"
+    "build": "tsc -p . && tsc -p ./tsconfig.cjs.json && tsconfig-to-dual-package",
+    "ci:version": "changeset version",
+    "ci:publish": "npm run build && changeset publish"
   },
   "repository": {
     "type": "git",
@@ -23,7 +25,8 @@
   },
   "homepage": "https://github.com/Robot-Inventor/eslint-config#readme",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "dependencies": {
     "@eslint/js": "^9.0.0",
@@ -34,6 +37,8 @@
     "typescript-eslint": "^7.6.0"
   },
   "devDependencies": {
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.1",
     "tsconfig-to-dual-package": "^1.2.0",
     "typescript": "^5.4.4"
   }

package/dist/esm/index.js

@@ -5,9 +5,7 @@ import eslintConfigPrettier from "eslint-config-prettier";
 const eslintConfigNoJSDoc = tseslint.config(eslint.configs.all, jsdoc.configs["flat/recommended-typescript-error"], eslintConfigPrettier, ...tseslint.configs.recommendedTypeChecked, {
     languageOptions: {
         parserOptions: {
-            project: true,
-            // @ts-expect-error
-            tsconfigRootDir: import.meta.dirname
+            project: true
         }
     },
     plugins: {

package/dist/esm/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@robot-inventor/eslint-config",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "My ESLint config preset",
   "type": "module",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "tsc -p . && tsc -p ./tsconfig.cjs.json && tsconfig-to-dual-package"
+    "build": "tsc -p . && tsc -p ./tsconfig.cjs.json && tsconfig-to-dual-package",
+    "ci:version": "changeset version",
+    "ci:publish": "npm run build && changeset publish"
   },
   "repository": {
     "type": "git",
@@ -23,7 +25,8 @@
   },
   "homepage": "https://github.com/Robot-Inventor/eslint-config#readme",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "dependencies": {
     "@eslint/js": "^9.0.0",
@@ -34,6 +37,8 @@
     "typescript-eslint": "^7.6.0"
   },
   "devDependencies": {
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.1",
     "tsconfig-to-dual-package": "^1.2.0",
     "typescript": "^5.4.4"
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robot-inventor/eslint-config",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "My ESLint config preset",
   "main": "dist/index.js",
   "type": "module",
@@ -18,7 +18,9 @@
     }
   },
   "scripts": {
-    "build": "tsc -p . && tsc -p ./tsconfig.cjs.json && tsconfig-to-dual-package"
+    "build": "tsc -p . && tsc -p ./tsconfig.cjs.json && tsconfig-to-dual-package",
+    "ci:version": "changeset version",
+    "ci:publish": "npm run build && changeset publish"
   },
   "repository": {
     "type": "git",
@@ -34,7 +36,8 @@
   },
   "homepage": "https://github.com/Robot-Inventor/eslint-config#readme",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "dependencies": {
     "@eslint/js": "^9.0.0",
@@ -45,7 +48,9 @@
     "typescript-eslint": "^7.6.0"
   },
   "devDependencies": {
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.1",
     "tsconfig-to-dual-package": "^1.2.0",
     "typescript": "^5.4.4"
   }
-}
+}