feat: add eslint and use it in all packages

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Program",
+      "skipFiles": ["<node_internals>/**"],
+      "program": "${workspaceFolder}/packages/dev-scripts/utils/standardize-pjson.js",
+      "outFiles": ["${workspaceFolder}/**/*.js"]
+    },
+    {
+      "name": "Attach",
+      "port": 9229,
+      "request": "attach",
+      "skipFiles": ["<node_internals>/**"],
+      "type": "pwa-node"
+    }
+  ]
+}

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "root",
+  "name": "dev-config",
   "private": true,
   "scripts": {
     "bootstrap": "lerna bootstrap",
@@ -16,12 +16,15 @@
     "lint-fix": "lerna run lint -- --fix",
     "postclean-all": "yarn sfdx-clean all",
     "prepack": "lerna run prepack",
-    "test": "lerna run test"
+    "test": "lerna run test",
+    "undefined": "lerna run undefined"
   },
   "devDependencies": {
     "cz-conventional-changelog": "^2.1.0",
-    "husky": "^1.3.1",
-    "lerna": "^3.15.0"
+    "husky": "^4.2.5",
+    "lerna": "^3.15.0",
+    "prettier": "^2.0.5",
+    "pretty-quick": "^2.0.1"
   },
   "config": {
     "commitizen": {

packages/dev-config/.sfdevrc.json

@@ -0,0 +1,3 @@
+{
+  "only-scripts": ["clean", "clean-all"]
+}

packages/dev-config/index.js

@@ -1,8 +1,6 @@
 const path = require('path');
-const tslint = require(path.join(__dirname, 'tslint'));
 const tsconfig = require(path.join(__dirname, 'tsconfig'));
 
 module.exports = {
-  tslint,
-  tsconfig
+  tsconfig,
 };

packages/dev-config/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/dev-config",
-  "version": "1.5.0",
+  "version": "2.0.0",
   "description": "A set of standard typescript config and tslint options for Salesforce projects.",
   "repository": "https://github.com/forcedotcom/sfdx-dev-packages",
   "main": "index.js",
@@ -22,16 +22,11 @@
     "/nyc.json",
     "/typedoc.js"
   ],
-  "dependencies": {
-    "tslint": "^5.18.0",
-    "tslint-microsoft-contrib": "^5.2.1",
-    "typescript": "~3.1.6"
-  },
   "scripts": {
     "clean-all": "shx rm -rf node_modules"
   },
   "devDependencies": {
-    "commitizen": "^3.1.1",
+    "commitizen": "^4.1.2",
     "shx": "^0.3.2"
   }
 }

packages/dev-scripts/bin/sfdx-clean.js

@@ -14,9 +14,9 @@ const defaultDirs = ['lib', '*coverage', '.nyc_output'];
 const defaultFiles = ['*xunit.xml', '*checkstyle.xml', 'yarn-error.log'];
 
 const packageRoot = require('../utils/package-path');
-const Config = require('../utils/sfdx-dev-config');
-const config = new Config(packageRoot);
-const clean = config.get('clean');
+const { resolveConfig } = require('../utils/sfdx-dev-config');
+const config = resolveConfig(packageRoot);
+const clean = config.clean;
 
 const cleanAll = process.argv[2] === 'all';
 
@@ -27,40 +27,40 @@ if (cleanAll) {
 
 if (!clean || clean.skipDefaults !== true) {
   log(`cleaning default directories: ${defaultDirs.join()}`);
-  defaultDirs.forEach(dir => {
+  defaultDirs.forEach((dir) => {
     shell.rm('-rf', join(packageRoot, dir));
   });
   log(`cleaning default files: ${defaultFiles.join()}`);
-  defaultFiles.forEach(file => {
+  defaultFiles.forEach((file) => {
     shell.rm('-f', join(packageRoot, file));
   });
 }
 
 if (clean && clean.dirs) {
   log(`cleaning config directories: ${clean.dirs.join()}`);
-  clean.dirs.forEach(dir => {
+  clean.dirs.forEach((dir) => {
     shell.rm('-rf', join(packageRoot, dir));
   });
 }
 
 if (clean && clean.files) {
   log(`cleaning config files: ${clean.files.join()}`);
-  clean.files.forEach(file => {
+  clean.files.forEach((file) => {
     shell.rm('-f', join(packageRoot, file));
   });
 }
 
 if (cleanAll) {
   if (clean && clean.allDirs) {
     log(`cleaning all directories: ${clean.allDirs.join()}`);
-    clean.allDirs.forEach(dir => {
+    clean.allDirs.forEach((dir) => {
       shell.rm('-rf', join(packageRoot, dir));
     });
   }
 
   if (clean && clean.allFiles) {
     log(`cleaning all files: ${clean.allFiles.join()}`);
-    clean.allFiles.forEach(file => {
+    clean.allFiles.forEach((file) => {
       shell.rm('-f', join(packageRoot, file));
     });
   }

packages/dev-scripts/bin/sfdx-lerna-install.js

@@ -9,19 +9,18 @@
 let chalk = require('chalk');
 const log = require('../utils/log');
 const writeDeps = require('../utils/write-dependencies');
+const packageRoot = require('../utils/package-path');
 
 let changed = false;
 log(`Writing dependencies for the lerna project`);
-changed = changed || writeDeps();
+changed = changed || writeDeps(packageRoot);
 
 // Run it for all packages in the lerna project
-changed =
-  changed || require('../utils/run-in-lerna-packages')('preinstall', writeDeps);
+changed = changed || require('../utils/run-in-lerna-packages')('preinstall', writeDeps);
 
 if (changed) {
   const errorHeader = chalk.red('ERROR: ');
-  const errorMsg =
-    "Dependencies have changed and saved to package.json. Rerun 'yarn install' to finish the install";
+  const errorMsg = "Dependencies have changed and saved to package.json. Rerun 'yarn install' to finish the install";
   console.error(chalk.bold(`\n${errorHeader}${errorMsg}\n`));
   process.exitCode = 1;
 } else {
@@ -37,7 +36,7 @@ if (changed) {
     standardizePjson(packagePath, inLernaProject);
   };
 
-  runAll();
+  runAll(packageRoot);
 
   // Run it for all packages in the lerna project
   require('../utils/run-in-lerna-packages')('postinstall', runAll);

packages/dev-scripts/bin/sfdx-lint.js

@@ -11,16 +11,16 @@ const shell = require('../utils/shelljs');
 const exists = require('../utils/exists');
 const packageRoot = require('../utils/package-path');
 
-const lint = require.resolve('tslint/bin/tslint');
+const lint = require.resolve('eslint/bin/eslint');
 
 const extras = process.argv.slice(2).join(' ');
-
-shell.exec(`${lint} -p . -t stylish ${extras}`, {
-  cwd: packageRoot
+console.log(`${lint} ${extras} ./src/**/*.ts`);
+shell.exec(`${lint} ${extras} ./src/**/*.ts`, {
+  cwd: packageRoot,
 });
 
 if (exists('./test')) {
-  shell.exec(`${lint} -p ./test -t stylish ${extras}`, {
-    cwd: packageRoot
+  shell.exec(`${lint} ${extras} ./test/**/*.ts`, {
+    cwd: packageRoot,
   });
 }

packages/dev-scripts/bin/sfdx-test.js

@@ -9,26 +9,25 @@
 const shell = require('../utils/shelljs');
 
 const packageRoot = require('../utils/package-path');
-const SfdxDevConfig = require('../utils/sfdx-dev-config');
+const { resolveConfig } = require('../utils/sfdx-dev-config');
 
 const nyc = require.resolve('nyc/bin/nyc');
 
-const config = new SfdxDevConfig(packageRoot);
-const testConfig = config.get('test') || {};
+const config = resolveConfig(packageRoot);
+const testConfig = config.test || {};
 
 let command = `${nyc} mocha`;
 
 if (!testConfig.mochaOpts) {
-  command +=
-    ' --require ts-node/register --require source-map-support/register';
+  command += ' --require ts-node/register --require source-map-support/register';
 }
 
 const includes = testConfig.testsPath || '**/*.test.ts';
 command += ` --recursive "${includes}"`;
 
 try {
   shell.exec(command, {
-    cwd: packageRoot
+    cwd: packageRoot,
   });
 } catch (err) {
   process.exitCode = 1;

packages/dev-scripts/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/dev-scripts",
-  "version": "0.4.2",
-  "description": "A set of standard package.json scripts for Salesforce projects.",
+  "version": "1.0.0",
+  "description": "Standardize package.json scripts and config files for Salesforce projects.",
   "repository": "https://github.com/forcedotcom/sfdx-dev-packages",
   "bin": {
     "sfdx-build": "bin/sfdx-build.js",
@@ -33,29 +33,35 @@
     "utils"
   ],
   "dependencies": {
-    "@commitlint/cli": "^8.1.0",
-    "@commitlint/config-conventional": "^7.6.0",
+    "@commitlint/cli": "^8.3.5",
+    "@commitlint/config-conventional": "^8.3.4",
     "@salesforce/dev-config": "^1.5.0",
-    "@types/chai": "^4.1.7",
-    "@types/mocha": "^5.2.7",
-    "@types/node": "^10.14.12",
-    "@types/sinon": "^4.3.3",
+    "@types/chai": "^4.2.11",
+    "@types/mocha": "^7.0.2",
+    "@types/node": "^12.12.6",
+    "@types/sinon": "^9.0.4",
     "chai": "^4.2.0",
-    "chalk": "2.4.2",
-    "mocha": "^5.2.0",
-    "nyc": "^13.3.0",
-    "prettier": "^1.18.2",
-    "pretty-quick": "^1.11.1",
-    "shelljs": "~0.8.3",
-    "sinon": "^5.1.1",
-    "source-map-support": "~0.5.12",
-    "ts-node": "^7.0.1",
-    "tslint": "^5.18.0",
-    "typedoc": "~0.15.0",
-    "typedoc-plugin-external-module-name": "~1.1.3",
+    "chalk": "^4.0.0",
+    "config": "^3.3.1",
+    "cosmiconfig": "^6.0.0",
+    "eslint-config-salesforce-typescript": "1.0.0",
+    "mocha": "^7.2.0",
+    "nyc": "^15.1.0",
+    "shelljs": "~0.8.4",
+    "sinon": "^9.0.2",
+    "source-map-support": "~0.5.19",
+    "ts-node": "^8.10.2",
+    "typedoc": "~0.17.7",
+    "typedoc-plugin-external-module-name": "~4.0.0",
+    "typescript": "^3.9.3",
     "xunit-file": "^1.0.0"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "devDependencies": {
+    "husky": "^4.2.5",
+    "prettier": "^2.0.5",
+    "pretty-quick": "^2.0.1"
   }
 }

packages/dev-scripts/utils/package-json.js

@@ -18,6 +18,7 @@ class PackageJson {
     this.pjsonPath = join(packageRoot, 'package.json');
     this.contents = require(this.pjsonPath);
     this.originalContents = this.stringify();
+    this.actions = [];
   }
 
   stringify() {
@@ -33,10 +34,13 @@ class PackageJson {
   write() {
     const pjson = this.stringify();
     if (this.originalContents !== pjson) {
+      log(`Found changes for ${this.contents.name}`);
+      for (const action of this.actions) {
+        log(action, 2);
+      }
+
       writeFileSync(this.pjsonPath, pjson);
       log(`wrote changes to ${this.pjsonPath}`, 1);
-    } else {
-      log('package.json not changed; skipping write', 2);
     }
   }
 

packages/dev-scripts/utils/run-in-lerna-packages.js

@@ -12,32 +12,28 @@ const packageRoot = require('./package-path');
 
 module.exports = (name, script) => {
   // Only get lerna packages that require @salesforce/dev-scripts
-  const packageList = readdirSync(join(packageRoot, 'packages')).filter(
-    name => {
-      try {
-        const pjson = require(join(
-          packageRoot,
-          'packages',
-          name,
-          'package.json'
-        ));
-        return (
-          pjson.dependencies['@salesforce/dev-scripts'] ||
-          pjson.devDependencies['@salesforce/dev-scripts']
-        );
-      } catch (e) {}
-      return false;
+  const packageList = readdirSync(join(packageRoot, 'packages')).filter((packageName) => {
+    try {
+      const pjson = require(join(packageRoot, 'packages', packageName, 'package.json'));
+      // TODO should inner packages even depend on this? Maybe it should be at the lerna level only
+      return (
+        (pjson.dependencies && pjson.dependencies['@salesforce/dev-scripts']) ||
+        (pjson.devDependencies && pjson.devDependencies['@salesforce/dev-scripts'])
+      );
+    } catch (e) {
+      console.warn(`Skipping ${packageName} because ${e.message}`);
     }
-  );
+    return false;
+  });
 
   log(`Running ${name} for packages ${packageList.join(', ')}`);
 
   let changed = false;
   try {
-    packageList.forEach(dir => {
-      // Run against the packages root
-      changed = changed || script(join(packageRoot, 'packages', dir), true);
-    });
+    for (const dir of packageList) {
+      // Run against all packages to update all package.json at once (don't short circuit).
+      changed = script(join(packageRoot, 'packages', dir), true) || changed;
+    }
   } catch (err) {
     console.error(err);
     process.exitCode = 1;