@oncehub/eslint-config 2.1.1 → 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Oncehub LTD
+
+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,26 +1,59 @@
-Introduction
-=
-ESLint configuration for micro-services built using Node.js and TypeScript. 
+# eslint-config-oncehub
+
+[![Build status](https://github.com/scheduleonce/eslint-config-oncehub/actions/workflows/node.js.yml/badge.svg)](https://github.com/scheduleonce/eslint-config-oncehub/actions) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+
+> ESLint configuration for services built with Node.js and TypeScript.
 
 The configuration extends `@typescript-eslint/recommended`, `eslint-plugin-sonarjs`, `prettier` ESLint configurations.
 
+It is compatible with ESlint >= v9 configuration format (flat config).
+
 ## Installation
-Using **NPM**
-```sh
-npm i --save-dev @oncehub/eslint-config
-```
 
-Using **Yarn**
+To install this module, run the following command:
+
 ```sh
-yarn add --dev @oncehub/eslint-config
+$ npm install --save-dev @oncehub/eslint-config
 ```
 
+Note that it requires ESlint v9 and above.
+
 ## Usage
+
 In your `.eslintrc` file, put `@oncehub/eslint-config` under `extends` array as shown below.
+
 ```js
 module.exports = {
-  'extends': [
-    '@oncehub/eslint-config'
-  ]
+  extends: ["@oncehub/eslint-config"],
 };
-```
+```
+
+## Development
+
+### Tests
+
+Run tests via `npm test`.
+The tests are comparing the eslint configuration against a previously saved snapshot of the rules so if you are adding or removing any rule, make sure to update the tests.
+
+As a byproduct, the tests are also checking that the configuration is valid and all is okay with it.
+You can also further debug the config via:
+
+```sh
+$ npx eslint --debug -c index.js index.js
+```
+
+To generate a new rules snapshot file:
+
+```sh
+$ npx eslint --print-config index.js -c index.js > output.json
+```
+
+Copy the rules from the output file into `test/rules-snapshot.js`
+
+### Deployment
+
+Package is automatically published to npm when [creating a new release](.github/workflows/npm-publish.yml) on Github. Check out the release section in the repo. Read more about releases [here](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository).
+
+## License
+
+This module is licensed under the MIT License. See the LICENSE file for details.

package/index.js

@@ -1,47 +1,48 @@
-module.exports = {
-  'env': {
-    'es6': true,
-    'node': true,
+import js from "@eslint/js";
+import prettierConfig from "eslint-config-prettier";
+import * as typescriptEslintPlugin from "@typescript-eslint/eslint-plugin";
+import sonarjs from "eslint-plugin-sonarjs";
+
+export default [
+  js.configs.recommended,
+  sonarjs.configs.recommended,
+  prettierConfig,
+  {
+    files: ["**/*.{js,ts,jsx,tsx}"],
+    languageOptions: {
+      globals: {
+        Atomics: "readonly",
+        SharedArrayBuffer: "readonly",
+        es6: true,
+        node: true,
+      },
+      parser: typescriptEslintPlugin.parser,
+      parserOptions: {
+        ecmaVersion: 2018,
+        sourceType: "module",
+      },
+    },
+    plugins: {
+      "@typescript-eslint": typescriptEslintPlugin,
+      // sonarjs,
+    },
+    rules: {
+      "@typescript-eslint/no-use-before-define": "off",
+      "@typescript-eslint/no-inferrable-types": "off",
+      "@typescript-eslint/no-unused-vars": "error",
+      "@typescript-eslint/interface-name-prefix": "off",
+      "@typescript-eslint/consistent-type-assertions": [
+        "error",
+        { assertionStyle: "angle-bracket" },
+      ],
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/explicit-function-return-type": "off",
+    },
   },
-  'extends': [
-    'plugin:@typescript-eslint/recommended',
-    'plugin:sonarjs/recommended',
-    'prettier'
-  ],
-  'globals': {
-    'Atomics': 'readonly',
-    'SharedArrayBuffer': 'readonly',
+  {
+    files: ["**/*(specs|tests)/**", "**/*.spec.ts"],
+    rules: {
+      "@typescript-eslint/no-empty-function": "off",
+    },
   },
-  'parser': '@typescript-eslint/parser',
-  'parserOptions': {
-    'ecmaVersion': 2018,
-    'sourceType': 'module',
-  },
-  'plugins': [
-    '@typescript-eslint',
-    'sonarjs'
-  ],
-  'overrides': [
-    {
-      'files': ['**/*(specs|tests)/**', '**/*.spec.ts'],
-      'rules': {
-        '@typescript-eslint/no-empty-function': 'off',
-        'sonarjs/no-identical-functions': 'off',
-        'sonarjs/no-duplicate-string': 'off'
-      }
-    }
-  ],
-  'rules': {
-    '@typescript-eslint/no-use-before-define': 'off',
-    '@typescript-eslint/no-inferrable-types': 'off',
-    '@typescript-eslint/explicit-function-return-type': 'error',
-    '@typescript-eslint/no-unused-vars': 'error',
-    '@typescript-eslint/no-explicit-any': 'error',
-    '@typescript-eslint/interface-name-prefix': 'off',
-    '@typescript-eslint/consistent-type-assertions': ['error', {
-      assertionStyle: 'angle-bracket'
-    }],
-    '@typescript-eslint/no-explicit-any': 'off',
-    '@typescript-eslint/explicit-function-return-type': 'off'
-  }
-};
+];

package/package.json

@@ -1,20 +1,26 @@
 {
   "name": "@oncehub/eslint-config",
-  "version": "2.1.1",
+  "version": "3.0.0",
   "description": "ESLint configuration for micro-services built using Node.js and TypeScript",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node test"
   },
+  "engines": {
+    "node": ">=18"
+  },
+  "type": "module",
   "author": "Rajat Saxena <rajat.saxena@oncehub.com>",
-  "license": "ISC",
+  "license": "MIT",
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.6.0",
-    "@typescript-eslint/parser": "^5.6.0",
-    "eslint": "^8.4.1",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-sonarjs": "^0.11.0",
-    "typescript": "^4.1.3"
+    "@eslint/js": "^9.14.0",
+    "@types/eslint__js": "^8.42.3",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-sonarjs": "^2.0.4",
+    "typescript-eslint": "^8.13.0"
+  },
+  "peerDependencies": {
+    "eslint": ">= 9"
   },
   "repository": {
     "type": "git",
@@ -23,5 +29,10 @@
   "bugs": {
     "url": "https://github.com/scheduleonce/eslint-config-oncehub/issues"
   },
-  "homepage": "https://github.com/scheduleonce/eslint-config-oncehub#readme"
+  "homepage": "https://github.com/scheduleonce/eslint-config-oncehub#readme",
+  "files": [
+    "index.js",
+    "README.md",
+    "LICENSE"
+  ]
 }