Merge pull request #3 from UziTech/tests

Add tests

Author: savetheclocktower

.eslintignore

@@ -0,0 +1 @@
+spec/fixtures

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,16 @@
+## Issue Type
+<!-- Can be "Bug", "Feature Request", "Question", etc.-->
+
+
+## Issue Description
+<!-- Describe what happened, what you think should have happened, and any other relevant details -->
+
+
+## Bug Checklist
+- [ ] Restart Atom
+- [ ] Verify the `eslint` CLI gives the proper result, while `linter-eslint-node` does not
+- [ ] Paste the output of the `Linter Eslint Node: Debug` command from the Command Palette below
+
+```
+Linter Eslint Node: Debug output here
+```

.github/renovate.json

@@ -0,0 +1,20 @@
+{
+  "schedule": ["every weekend"],
+  "labels": ["dependencies"],
+  "separateMajorMinor": "false",
+  "packageRules": [
+    {
+      "matchDepTypes": ["devDependencies"],
+      "matchUpdateTypes": ["major", "minor", "patch", "pin", "digest", "lockFileMaintenance", "rollback", "bump"],
+      "groupName": "devDependencies",
+      "semanticCommitType": "chore",
+      "automerge": true
+    },
+    {
+      "matchDepTypes": ["dependencies"],
+      "matchUpdateTypes": ["major", "minor", "patch", "pin", "digest", "lockFileMaintenance", "rollback", "bump"],
+      "groupName": "dependencies",
+      "semanticCommitType": "fix"
+    }
+  ]
+}

.github/workflows/CI.yml

@@ -0,0 +1,77 @@
+name: CI
+on:
+  - pull_request
+  - push
+
+jobs:
+  Test:
+    name: ${{ matrix.os }} - Atom ${{ matrix.atom_channel }} - node ${{ matrix.node_version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        atom_channel: [stable, beta]
+        node_version: ['lts/*']
+        include:
+          - os: ubuntu-latest
+            atom_channel: stable
+            node_version: '*'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: UziTech/action-setup-atom@v2
+        with:
+          version: ${{ matrix.atom_channel }}
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node_version }}
+      - name: Install dependencies
+        run: |
+          apm install
+          # ./node_modules/.bin/atom-package-deps .
+
+      - name: Run tests 👩🏾‍💻
+        run: npm run test
+
+  Lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Lint ✨
+        run: npm run test.lint
+
+  CommitLint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Commit lint ✨
+        uses: wagoid/commitlint-github-action@v4
+
+  # Release:
+  #   needs: [Test, CommitLint, Lint]
+  #   if: github.ref == 'refs/heads/master' &&
+  #     github.event.repository.fork == false
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v2
+  #     - uses: UziTech/action-setup-atom@v1
+  #     - uses: actions/setup-node@v3
+  #       with:
+  #         node-version: "lts/*"
+  #     - name: NPM install
+  #       run: npm install
+  #     - name: Release 🎉
+  #       uses: cycjimmy/semantic-release-action@v2
+  #       with:
+  #         extends: @semantic-release/apm-config
+  #       env:
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #         ATOM_ACCESS_TOKEN: ${{ secrets.ATOM_ACCESS_TOKEN  }}

lib/config.js

@@ -9,6 +9,7 @@ const Config = {
   subscriptions: null,
   initialized: false,
   handlers: [],
+  overrides: {},
 
   initialize () {
     if (this.initialized) { return; }

lib/main.js

@@ -11,52 +11,14 @@ import NodePathTester from './node-path-tester';
 import JobManager from './job-manager';
 import * as helpers from './helpers';
 
-const IDLE_CALLBACKS = new Set();
-
-const makeIdleCallback = work => {
-  let callbackId;
-  const callback = () => {
-    IDLE_CALLBACKS.delete(callbackId);
-    work();
-  };
-  callbackId = window.requestIdleCallback(callback);
-  IDLE_CALLBACKS.add(callbackId);
-};
-
-const scheduleIdleTasks = () => {
-  const linterEslintInstallPeerPackages = () => {
-    require('atom-package-deps').install('linter-eslint-node');
-  };
-
-  if (!atom.inSpecMode()) {
-    makeIdleCallback(linterEslintInstallPeerPackages);
-  }
-};
-
-const SCOPES = atom.config.get('linter-eslint-node.scopes');
-
-const EMBEDDED_SCOPE = 'source.js.embedded.html';
-
 const BUTTON_SETTINGS = {
   text: 'Settings',
   onDidClick () {
     atom.workspace.open(`atom://config/packages/linter-eslint-node`);
   }
 };
 
-
-if (atom.config.get('linter-eslint-node.lintHtmlFiles')) {
-  if (!SCOPES.includes(EMBEDDED_SCOPE)) {
-    SCOPES.push(EMBEDDED_SCOPE);
-  }
-} else {
-  if (SCOPES.includes(EMBEDDED_SCOPE)) {
-    SCOPES.splice(
-      SCOPES.indexOf(EMBEDDED_SCOPE),
-      1
-    );
-  }
-}
+const EMBEDDED_SCOPE = 'source.js.embedded.html';
 
 const RECENTLY_SAVED = new Set();
 function hasRecentlySaved (path) {
@@ -65,8 +27,20 @@ function hasRecentlySaved (path) {
   setTimeout(() => RECENTLY_SAVED.delete(path), 100);
 }
 
-class LinterESLintNode {
-  constructor () {
+export default {
+
+  shouldAutoFix (textEditor) {
+    if (textEditor.isModified()) { return false; }
+    if (!Config.get('autofix.fixOnSave')) { return false; }
+    if (!helpers.hasValidScope(textEditor, this.scopes)) { return false; }
+    return true;
+  },
+
+  isLegacyPackagePresent () {
+    return ('linter-eslint' in atom.packages.activePackages);
+  },
+
+  async activate () {
     Config.initialize();
     this.workerPath = Path.join(__dirname, 'worker.js');
     NodePathTester.test(Config.get('nodeBin'));
@@ -79,21 +53,23 @@ class LinterESLintNode {
       incompatibleVersion: false,
       invalidNodeBin: false
     };
-  }
 
-  shouldAutoFix (textEditor) {
-    if (textEditor.isModified()) { return false; }
-    if (!Config.get('autofix.fixOnSave')) { return false; }
-    if (!helpers.hasValidScope(textEditor, SCOPES)) { return false; }
-    return true;
-  }
+    this.subscriptions = new CompositeDisposable();
 
-  isLegacyPackagePresent () {
-    return ('linter-eslint' in atom.packages.activePackages);
-  }
+    this.scopes = atom.config.get('linter-eslint-node.scopes');
 
-  async activate () {
-    this.subscriptions = new CompositeDisposable();
+    if (atom.config.get('linter-eslint-node.lintHtmlFiles')) {
+      if (!this.scopes.includes(EMBEDDED_SCOPE)) {
+        this.scopes.push(EMBEDDED_SCOPE);
+      }
+    } else {
+      if (this.scopes.includes(EMBEDDED_SCOPE)) {
+        this.scopes.splice(
+          this.scopes.indexOf(EMBEDDED_SCOPE),
+          1
+        );
+      }
+    }
 
     this.subscriptions.add(
       atom.workspace.observeTextEditors(
@@ -127,21 +103,21 @@ class LinterESLintNode {
           }
 
           if (config.scopes !== prevConfig.scopes) {
-            SCOPES.splice(0, SCOPES.length);
-            SCOPES.push(...config.scopes);
+            this.scopes.splice(0, this.scopes.length);
+            this.scopes.push(...config.scopes);
             if (config.lintHtmlFiles) {
-              SCOPES.push(EMBEDDED_SCOPE);
+              this.scopes.push(EMBEDDED_SCOPE);
             }
           }
 
           if (config.lintHtmlFiles !== prevConfig.lintHtmlFiles) {
             if (config.lintHtmlFiles) {
-              if (!SCOPES.includes(EMBEDDED_SCOPE)) {
-                SCOPES.push(EMBEDDED_SCOPE);
+              if (!this.scopes.includes(EMBEDDED_SCOPE)) {
+                this.scopes.push(EMBEDDED_SCOPE);
               }
             } else {
-              if (SCOPES.includes(EMBEDDED_SCOPE)) {
-                SCOPES.splice(SCOPES.indexOf(EMBEDDED_SCOPE), 1);
+              if (this.scopes.includes(EMBEDDED_SCOPE)) {
+                this.scopes.splice(this.scopes.indexOf(EMBEDDED_SCOPE), 1);
               }
             }
           }
@@ -186,14 +162,16 @@ class LinterESLintNode {
       })
     );
 
-    scheduleIdleTasks();
-  }
+    if (!atom.inSpecMode()) {
+      await require('atom-package-deps').install('linter-eslint-node');
+    }
+  },
 
   async deactivate () {
     this.subscriptions.dispose();
     this.jobManager.dispose();
     Config.dispose();
-  }
+  },
 
   notifyAboutInvalidNodeBin () {
     if (this.notified.invalidNodeBin) { return; }
@@ -207,7 +185,7 @@ class LinterESLintNode {
       }
     );
     this.notified.invalidNodeBin = true;
-  }
+  },
 
   // We need to tell the worker to clear its cache when
   // - any .eslintignore file is changed;
@@ -217,7 +195,7 @@ class LinterESLintNode {
   clearESLintCache () {
     console.warn('Telling the worker to clear its cache!');
     this.jobManager.send({ type: 'clear-cache' });
-  }
+  },
 
   // Show a bunch of stuff to the user that can help them figure out why the
   // package isn't behaving the way they think it ought to, or else give them
@@ -331,7 +309,7 @@ class LinterESLintNode {
         dismissable: true
       }
     );
-  }
+  },
 
   // Here we're operating entirely outside the purview of the `linter` package.
   // This method is called either automatically, via `fixOnSave`; or manually,
@@ -386,7 +364,7 @@ class LinterESLintNode {
       this.handleError(err);
       return;
     }
-  }
+  },
 
   handleError (err) {
     console.debug('handleError:', err);
@@ -451,15 +429,15 @@ class LinterESLintNode {
         }
       );
     }
-  }
+  },
 
   provideLinter () {
     console.log('provideLinter nodeBin:', Config.get('nodeBin'));
     return {
       name: 'ESLint (Node)',
       scope: 'file',
       lintsOnChange: true,
-      grammarScopes: SCOPES,
+      grammarScopes: this.scopes,
       lint: async (textEditor) => {
         console.warn('linting', textEditor);
         if (!atom.workspace.isTextEditor(textEditor)) {
@@ -545,8 +523,5 @@ class LinterESLintNode {
         }
       }
     };
-  }
-}
-
-
-export default new LinterESLintNode();
+  },
+};