feat(atlauncher-scripts): if project uses lerna, run lint on packagesthis allows for atlauncher-scripts to be used in the root of a lerna project and it's commands (such as linting JS files) to be run on all lerna projects defined in lerna.json

Author: RyanTheAllmighty

packages/atlauncher-scripts/scripts/lint-js.js

@@ -17,11 +17,7 @@ if (args.length) {
 }
 
 if (watch) {
-    const processArguments = [
-        utils.getProjectPath('src/**/*.js'),
-        '--initial',
-        '-c npm run lint:js',
-    ];
+    const processArguments = [utils.getProjectPath('src/**/*.js'), '--initial', '-c npm run lint:js'];
 
     utils.spawnSyncProcess(utils.getNodeModulesBinPath('chokidar'), processArguments);
 
@@ -33,8 +29,11 @@ const processArguments = [
     utils.getConfigFile('.eslintrc'),
     '--ignore-path',
     utils.getConfigFile('.eslintignore'),
+    '--ignore-pattern',
+    '**/node_modules/**',
+    '--ignore-pattern',
+    '**/coverage/**',
     debug && '--debug',
-    utils.getProjectPath('src/**/*.js'),
-];
+].concat(utils.getProjectPaths('**/*.js'));
 
-utils.spawnSyncProcess(utils.getNodeModulesBinPath('eslint'), processArguments);
+utils.spawnSyncProcess(utils.getNodeModulesBinPath('eslint'), processArgumentsS);

packages/atlauncher-scripts/utils/index.js

@@ -5,15 +5,76 @@ const spawn = require('cross-spawn');
 const isWindows = require('is-windows');
 
 /**
- * This gets a path to the project (where atlauncher-scripts was called from).
+ * This will read the lerna.json file (if available).
+ *
+ * @returns {string[]}
+ */
+function getLernaPackagePaths() {
+    const lernaJsonPath = path.resolve(process.cwd(), 'lerna.json');
+
+    if (!fs.existsSync(lernaJsonPath)) {
+        return [];
+    }
+
+    const { packages = [] } = JSON.parse(fs.readFileSync(lernaJsonPath, 'utf8'));
+
+    return packages;
+}
+
+/**
+ * This ensures that the given path always ends with a / (or not);
+ *
+ * @param {string} path
+ * @param {boolean} [ensureLastSlash=true]
+ * @returns string
+ */
+function ensureLastSlash(path, ensureLastSlash = true) {
+    if (ensureLastSlash && path.substr(path, -1) !== '/') {
+        return `${path}/`;
+    }
+
+    if (!ensureLastSlash && path.substr(path, -1) === '/') {
+        return path.substr(path, 0, -1);
+    }
+
+    return path;
+}
+
+/**
+ * This gets a path (or paths if lerna) to the project (where atlauncher-scripts was called from).
  *
  * @param {string} [pathString=''] the path to get, otherwise the root
- * @returns {string}
+ * @param {boolean} [lernaCheck=false] if we should check for lerna
+ * @returns {string|string[]}
  */
-function getProjectPath(pathString = '') {
+function getProjectPath(pathString = '', lernaCheck = false) {
+    if (lernaCheck) {
+        const lernaPackages = getLernaPackagePaths();
+
+        if (lernaPackages.length) {
+            return lernaPackages.map((package) => path.resolve(process.cwd(), ensureLastSlash(package), pathString));
+        }
+    }
+
     return path.resolve(process.cwd(), pathString);
 }
 
+/**
+ * This gets the paths (if lerna) to the project (where atlauncher-scripts was called from).
+ *
+ * @param {string} [pathString=''] the path to get, otherwise the root
+ * @returns {string[]}
+ */
+function getProjectPaths(pathString = '') {
+    const paths = getProjectPath(pathString, true);
+
+    if (!Array.isArray(paths)) {
+        return [paths];
+    }
+
+    return paths;
+}
+
 /**
  * This reads in the projects package.json (if it exists) and returns it as an object.
  *
@@ -186,17 +247,17 @@ function spawnSyncProcess(command = 'node', processes = [], workingDirectory = g
                 console.log(
                     chalk.white.bgRed(
                         'Commit Linting failed because the process exited too early. ' +
-                        'This probably means the system ran out of memory or someone called ' +
-                        '`kill -9` on the process.'
-                    )
+                            'This probably means the system ran out of memory or someone called ' +
+                            '`kill -9` on the process.',
+                    ),
                 );
             } else if (result.signal === 'SIGTERM') {
                 console.log(
                     chalk.white.bgRed(
                         'Commit Linting failed because the process exited too early. ' +
-                        'Someone might have called `kill` or `killall`, or the system could ' +
-                        'be shutting down.'
-                    )
+                            'Someone might have called `kill` or `killall`, or the system could ' +
+                            'be shutting down.',
+                    ),
                 );
             }
 
@@ -212,6 +273,7 @@ module.exports = {
     getScripts,
     getConfigFile,
     getProjectPath,
+    getProjectPaths,
     spawnSyncProcess,
     getNodeModulesPath,
     getNodeModulesBinPath,