Adds rule that detects potential sensitive tokens in ts, js and json files (#1)

Author: badiuoanaalexandra

.github/workflows/basic.yml

@@ -0,0 +1,35 @@
+name: Basic Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+env:
+  nodeVersion: 22
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install npm dependencies
+        run: npm install
+
+  lint:
+    runs-on: ubuntu-latest
+    needs: prepare
+    steps:
+      - uses: actions/checkout@v4
+
+      - run: npm install
+      - run: npm run lint
+
+  test:
+    runs-on: ubuntu-latest
+    needs: prepare
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm install
+      - run: npm run test

.gitignore

@@ -0,0 +1 @@
+node_modules

.nvm

@@ -0,0 +1 @@
+22

.prettierrc.yml

@@ -0,0 +1,3 @@
+singleQuote: true
+trailingComma: 'none'
+arrowParens: 'always'

CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 1.0.0 (2025-03-13)
+- Add custom rule for detecting potential sensitive tokens in js, ts and json files

README.md

@@ -1,2 +1,54 @@
 # eslint-plugin-mapbox-token
-Eslint plugin that recognizes tokens in js, ts and json files
+
+This eslint plugin contains custom eslint rules. 
+
+## Usage
+
+```sh
+    npm install --save-dev @mapbox/eslint-plugin-mapbox
+```
+
+
+Example of eslint.config.cjs for eslint version 9:
+
+```sh
+    const mapbox = require('@mapbox/eslint-plugin-mapbox');
+    module.exports = [
+        ...mapbox.configs.recommended,
+    ]
+```
+
+
+Example of eslint config file for eslint version 8:
+
+```sh
+    module.exports = {
+    extends: 'eslint:recommended',
+    env: {
+        es6: true
+    },
+    parserOptions: {
+        ecmaVersion: 2020
+    },
+    plugins: ['jsonc', '@mapbox/mapbox'],
+    rules: {
+        ... other rules
+        '@mapbox/mapbox/detect-token': 'error'
+    },
+    overrides: [
+        {
+        files: ['*.json', '*.jsonc'],
+        parser: 'jsonc-eslint-parser',
+        rules: {
+
+            ... other rules
+            '@mapbox/mapbox/detect-token'': 'error',
+        }
+        }
+    ]
+    };
+```
+
+## Rules
+
+`detect-token` : Detects potential sensitive tokens in .ts, .tsx, .js, .jsx and .json files

eslint.config.mjs

@@ -0,0 +1,13 @@
+import js from '@eslint/js';
+import globals from 'globals';
+
+export default [
+  js.configs.recommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node
+      }
+    }
+  }
+];

index.js

@@ -0,0 +1,25 @@
+'use strict';
+
+const detectTokenRule = require('./rules/detect-token');
+
+const plugin = {
+  rules: {
+    'detect-token': detectTokenRule
+  },
+  configs: {}
+};
+
+Object.assign(plugin.configs, {
+  recommended: [
+    {
+      plugins: {
+        '@mapbox/mapbox': plugin
+      },
+      rules: {
+        '@mapbox/mapbox/detect-token': 'error'
+      }
+    }
+  ]
+});
+
+module.exports = plugin;