@1024pix/eslint-plugin 1.0.0

package/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: npm publish @1024pix/eslint-plugin
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        type: choice
+        required: true
+        options:
+          - patch
+          - minor
+          - major
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: .nvmrc
+          cache: npm
+          registry-url: https://registry.npmjs.org/
+      - name: Setup git user
+        run: |
+          git config --global user.name "pix-service-auto-merge"
+          git config --global user.email "service+github.auto-merge@pix.fr"
+      - run: npm version ${{ inputs.version }}
+      - run: git push && git push --tags
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_PUBLISH_ACCESS_TOKEN}}

package/.github/workflows/test.yml

@@ -0,0 +1,16 @@
+name: npm run test
+
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+
+      - run: npm ci
+      - run: npm test

package/.nvmrc

@@ -0,0 +1 @@
+18.18.0

package/index.js

@@ -0,0 +1,6 @@
+'use strict';
+const noSinonStubWithArgsOneliner = require('./rules/no-sinon-stub-with-args-oneliner.js');
+
+module.exports = {
+  rules: { 'no-sinon-stub-with-args-oneliner': noSinonStubWithArgsOneliner },
+};

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@1024pix/eslint-plugin",
+  "version": "1.0.0",
+  "description": "Des règles de lint pour les projets 1024pix",
+  "main": "index.js",
+  "scripts": {
+    "test": "node rules/*.test.js"
+  },
+  "devDependencies": {
+    "eslint": "^8.50.0"
+  }
+}

package/renovate.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["local>1024pix/renovate-config"]
+}

package/rules/no-sinon-stub-with-args-oneliner.js

@@ -0,0 +1,42 @@
+'use strict';
+
+function report(context, node) {
+  context.report({
+    node: node,
+    messageId: 'chainError',
+  });
+}
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'Do not chain `sinon.stub()` with the `withArgs()` method in a one-liner',
+    },
+    messages: {
+      chainError:
+        '`sinon.stub()` should not be chained with the `withArgs` method.',
+    },
+  },
+  create: function (context) {
+    return {
+      'VariableDeclarator > CallExpression > MemberExpression[property.name="returns"] > CallExpression > MemberExpression[property.name="withArgs"] > CallExpression > MemberExpression[property.name="stub"][object.name="sinon"]':
+        function (node) {
+          report(context, node);
+        },
+      'VariableDeclarator > CallExpression > MemberExpression[property.name="throws"] > CallExpression > MemberExpression[property.name="withArgs"] > CallExpression > MemberExpression[property.name="stub"][object.name="sinon"]':
+        function (node) {
+          report(context, node);
+        },
+      'VariableDeclarator > CallExpression > MemberExpression[property.name="resolves"] > CallExpression > MemberExpression[property.name="withArgs"] > CallExpression > MemberExpression[property.name="stub"][object.name="sinon"]':
+        function (node) {
+          report(context, node);
+        },
+      'VariableDeclarator > CallExpression > MemberExpression[property.name="rejects"] > CallExpression > MemberExpression[property.name="withArgs"] > CallExpression > MemberExpression[property.name="stub"][object.name="sinon"]':
+        function (node) {
+          report(context, node);
+        },
+    };
+  },
+};

package/rules/no-sinon-stub-with-args-oneliner.test.js

@@ -0,0 +1,62 @@
+'use strict';
+
+const rule = require('./no-sinon-stub-with-args-oneliner.js'),
+  RuleTester = require('eslint').RuleTester;
+
+const ruleTester = new RuleTester({
+  parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+});
+
+ruleTester.run('no-sinon-stub-with-args-oneliner', rule, {
+  valid: [
+    {
+      name: 'Only stub',
+      code: 'sinon.stub()',
+    },
+    {
+      name: 'Sinon import then two liners',
+      code: "const stub = sinon.stub(); stub.withArgs('hello').returns('world')",
+    },
+    {
+      name: 'Sinon import then object definition',
+      code: "import sinon from 'sinon'; const stub = { hello: sinon.stub().withArgs('hello').returns('world') }",
+    },
+    {
+      name: 'Stub import then two liners',
+      code: "import { stub } from 'sinon'; const myStub = stub(); myStub.withArgs('hello').returns('world')",
+    },
+
+    // Not handled yet
+    {
+      name: 'Sinon import then onCall one liner',
+      code: "import sinon from 'sinon'; const myStub = sinon.stub().withArgs('hello').onCall(0).returns('world')",
+    },
+    {
+      name: 'Stub import then one liner',
+      code: "import { stub } from 'sinon'; const myStub = stub().withArgs('hello').returns('world')",
+    },
+  ],
+
+  invalid: [
+    {
+      name: 'One liner variable assignment with sinon import and returns',
+      code: `import sinon from 'sinon'; const stub = sinon.stub().withArgs('hello').returns('world')`,
+      errors: [{ messageId: 'chainError' }],
+    },
+    {
+      name: 'One liner variable assignment with sinon import and throws',
+      code: `import sinon from 'sinon'; const stub = sinon.stub().withArgs('hello').throws('world')`,
+      errors: [{ messageId: 'chainError' }],
+    },
+    {
+      name: 'One liner variable assignment with sinon import and resolves',
+      code: `import sinon from 'sinon'; const stub = sinon.stub().withArgs('hello').resolves('world')`,
+      errors: [{ messageId: 'chainError' }],
+    },
+    {
+      name: 'One liner variable assignment with sinon import and rejects',
+      code: `import sinon from 'sinon'; const stub = sinon.stub().withArgs('hello').rejects('world')`,
+      errors: [{ messageId: 'chainError' }],
+    },
+  ],
+});