Merge pull request #54 from vzamanillo/v2-linter-api-support

V2 linter API support

Author: vzamanillo

.circleci/config.yml

@@ -0,0 +1,125 @@
+version: 2
+
+defaults: &defaults
+  working_directory: /tmp/project
+  environment:
+    APM_TEST_PACKAGES: "language-lua"
+  docker:
+    - image: arcanemagus/atom-docker-ci:stable
+  steps:
+    # Restore project state
+    - attach_workspace:
+        at: /tmp
+    - run:
+        name: Install luac and luajit
+        command: |
+          sudo apt-get update && \
+          sudo apt-get install --assume-yes --quiet --no-install-suggests \
+            --no-install-recommends lua5.3 luajit && \
+          sudo update-alternatives --install /usr/bin/lua lua-interpreter \
+            /usr/bin/lua5.3 130 --slave /usr/share/man/man1/lua.1.gz lua-manual /usr/share/man/man1/lua5.3.1.gz && \
+          sudo update-alternatives --install /usr/bin/luac lua-compiler \
+            /usr/bin/luac5.3 130 --slave /usr/share/man/man1/luac.1.gz lua-compiler-manual /usr/share/man/man1/luac5.3.1.gz
+    - run:
+        name: Luac version
+        command: luac -v
+    - run:
+        name: Luajit version
+        command: luajit -v
+    - run:
+        name: Create VFB for Atom to run in
+        command: /usr/local/bin/xvfb_start
+    - run:
+        name: Atom version
+        command: ${ATOM_SCRIPT_PATH} --version
+    - run:
+        name: APM version
+        command: ${APM_SCRIPT_PATH} --version
+    - run:
+        name: Package APM package dependencies
+        command: |
+          if [ -n "${APM_TEST_PACKAGES}" ]; then
+            for pack in ${APM_TEST_PACKAGES}; do
+            ${APM_SCRIPT_PATH} install "${pack}"
+            done
+          fi;
+    - run:
+        name: Package dependencies
+        command: ${APM_SCRIPT_PATH} install
+    - run:
+        name: Cleaning package
+        command: ${APM_SCRIPT_PATH} clean
+    - run:
+        name: Package specs
+        command: ${ATOM_SCRIPT_PATH} --test spec
+    # Cache node_modules
+    - save_cache:
+        paths:
+          - node_modules
+        key: v1-dependencies-{{ .Branch }}-{{ checksum "package.json" }}-{{ checksum "package-lock.json"}}
+
+jobs:
+  checkout_code:
+    <<: *defaults
+    docker:
+      - image: circleci/node:latest
+    steps:
+      - checkout
+      # Restore node_modules from the last build
+      - restore_cache:
+          keys:
+          # Get latest cache for this package.json and package-lock.json
+          - v1-dependencies-{{ .Branch }}-{{ checksum "package.json" }}-{{ checksum "package-lock.json"}}
+          # Fallback to the current package.json
+          - v1-dependencies-{{ .Branch }}-{{ checksum "package.json" }}-
+          # Fallback to the last build for this branch
+          - v1-dependencies-{{ .Branch }}-
+          # Fallback to the last available master branch cache
+          - v1-dependencies-master-
+          # Don't go further down to prevent dependency issues from other branches
+      # Save project state for next steps
+      - persist_to_workspace:
+          root: /tmp
+          paths:
+            - project
+  lint:
+    <<: *defaults
+    docker:
+      - image: circleci/node:lts
+    steps:
+      # Restore project state
+      - attach_workspace:
+          at: /tmp
+      - run:
+          name: Node.js Version
+          command: node --version
+      - run:
+          name: NPM Version
+          command: npm --version
+      - run:
+          name: Install any remaining dependencies
+          command: npm install
+      - run:
+          name: Lint code
+          command: npm run lint
+  stable:
+    <<: *defaults
+  beta:
+    <<: *defaults
+    docker:
+      - image: arcanemagus/atom-docker-ci:beta
+
+workflows:
+  version: 2
+  test_package:
+    jobs:
+      - checkout_code
+      - lint:
+          requires:
+            - checkout_code
+      - stable:
+          requires:
+            - lint
+      - beta:
+          requires:
+            - lint

.travis.yml

@@ -0,0 +1,53 @@
+### Project specific config ###
+
+language: generic
+
+matrix:
+  include:
+    - os: linux
+      env: ATOM_CHANNEL=stable
+
+    - os: linux
+      env: ATOM_CHANNEL=beta
+
+env:
+  global:
+    APM_TEST_PACKAGES: "language-lua"
+
+install:
+  - sudo apt-get update
+  - sudo apt-get install --assume-yes --quiet --no-install-suggests --no-install-recommends lua5.2 luajit
+
+before_script:
+  - luac -v
+  - luajit -v
+
+### Generic setup follows ###
+script:
+  - curl -s -O https://raw.githubusercontent.com/atom/ci/master/build-package.sh
+  - chmod u+x build-package.sh
+  - "./build-package.sh"
+
+notifications:
+  email:
+    on_success: never
+    on_failure: change
+
+branches:
+  only:
+    - master
+
+git:
+  depth: 10
+
+sudo: false
+
+dist: trusty
+
+addons:
+  apt:
+    packages:
+    - build-essential
+    - fakeroot
+    - git
+    - libsecret-1-dev

lib/init.js

@@ -0,0 +1,126 @@
+'use babel';
+
+// eslint-disable-next-line import/no-extraneous-dependencies, import/extensions
+import { CompositeDisposable } from 'atom';
+
+let helpers;
+
+const REGEX = /^.+?:.+?:(\d+):\s+(.+?(?:near (.+)|$))/g;
+
+const loadDeps = () => {
+  if (!helpers) {
+    helpers = require('atom-linter');
+  }
+};
+
+const parseLuacOutput = (output, file, editor) => {
+  const messages = [];
+  let match = REGEX.exec(output);
+  while (match !== null) {
+    const line = Number.parseInt(match[1], 10) - 1;
+    messages.push({
+      severity: 'error',
+      excerpt: match[2],
+      location: {
+        file,
+        position: helpers.generateRange(editor, line),
+      },
+    });
+    match = REGEX.exec(output);
+  }
+  return messages;
+};
+
+module.exports = {
+  activate() {
+    this.idleCallbacks = new Set();
+    let depsCallbackID;
+    const installLinterLuaDeps = () => {
+      this.idleCallbacks.delete(depsCallbackID);
+      if (!atom.inSpecMode()) {
+        require('atom-package-deps').install('linter-lua');
+      }
+      loadDeps();
+    };
+    depsCallbackID = window.requestIdleCallback(installLinterLuaDeps);
+    this.idleCallbacks.add(depsCallbackID);
+
+    this.subscriptions = new CompositeDisposable();
+    this.subscriptions.add(
+      atom.config.observe(
+        'linter-lua.executablePath',
+        (value) => { this.executablePath = value; },
+      ),
+    );
+  },
+
+  deactivate() {
+    this.idleCallbacks.forEach(callbackID => window.cancelIdleCallback(callbackID));
+    this.idleCallbacks.clear();
+    this.subscriptions.dispose();
+  },
+
+  provideLinter() {
+    return {
+      name: 'Lua',
+      grammarScopes: ['source.lua'],
+      scope: 'file',
+      lintsOnChange: true,
+      lint: async (editor) => {
+        if (!atom.workspace.isTextEditor(editor)) {
+          // If we somehow get fed an invalid TextEditor just immediately return
+          return null;
+        }
+
+        const filePath = editor.getPath();
+        if (!filePath) {
+          return null;
+        }
+
+        loadDeps();
+
+        const args = [];
+
+        if (this.executablePath.indexOf('luajit') !== -1) {
+          args.push('-bl');
+        } else {
+          args.push('-p');
+        }
+
+        args.push('-'); // to indicate that the input is in stdin
+
+        const stdin = editor.getText();
+
+        const execOptions = {
+          stdin,
+          stream: 'stderr',
+          uniqueKey: `linter-lua::${filePath}`,
+          allowEmptyStderr: true,
+        };
+
+        let output;
+        try {
+          output = await helpers.exec(this.executablePath, args, execOptions);
+        } catch (e) {
+          if (e.message === 'Process execution timed out') {
+            atom.notifications.addInfo(`linter-lua: ${this.executablePath} timed out`, {
+              description: `A timeout occured while executing ${this.executablePath}, it could be due to lower resources `
+                           + 'or a temporary overload.',
+            });
+          } else {
+            atom.notifications.addError('linter-lua: Unexpected error', { description: e.message });
+          }
+          return null;
+        }
+
+        if (editor.getText() !== stdin || output === null) {
+          // File has changed since the lint was triggered, tell Linter not to update or
+          // process was canceled by newer process
+          return null;
+        }
+
+        return parseLuacOutput(output, filePath, editor);
+      },
+    };
+  },
+};