tslint: use a better implementation of rule checking unused variables

bin/sync-dev-deps.js

@@ -0,0 +1,63 @@
+#!/usr/bin/env node
+// Copyright IBM Corp. 2017,2018. All Rights Reserved.
+// Node module: loopback-next
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+/**
+ * This is an internal script to synchronize versions of dev-dependencies
+ * from monorepo's package.json to individual example packages.
+ */
+'use strict';
+
+const path = require('path');
+const fs = require('fs');
+
+const Project = require('@lerna/project');
+
+async function syncDevDeps() {
+  const project = new Project(process.cwd());
+  const packages = await project.getPackages();
+
+  const rootPath = project.rootPath;
+
+  // Load dependencies from `packages/build/package.json`
+  const buildDeps = require(path.join(rootPath, 'packages/build/package.json'))
+    .dependencies;
+
+  const masterDeps = {
+    typescript: buildDeps.typescript,
+    tslint: buildDeps.tslint,
+  };
+
+  // Update typescript & tslint dependencies in individual packages
+  for (const pkg of packages) {
+    const data = readJsonFile(pkg.manifestLocation);
+    let modified = false;
+    for (const dep in masterDeps) {
+      if (data.devDependencies && dep in data.devDependencies) {
+        data.devDependencies[dep] = masterDeps[dep];
+        modified = true;
+      }
+    }
+    if (!modified) continue;
+    writeJsonFile(pkg.manifestLocation, data);
+  }
+
+  // Update dependencies in monorepo root
+  const rootPackage = path.join(rootPath, 'package.json');
+  const data = readJsonFile(rootPackage);
+  Object.assign(data.devDependencies, masterDeps);
+  writeJsonFile(rootPackage, data);
+}
+
+if (require.main === module) syncDevDeps();
+
+function readJsonFile(filePath) {
+  return JSON.parse(fs.readFileSync(filePath, 'utf-8'));
+}
+
+function writeJsonFile(filePath, data) {
+  fs.writeFileSync(filePath, JSON.stringify(data, null, 2) + '\n', 'utf-8');
+  console.log('%s has been updated.', filePath);
+}

bin/travis.sh

@@ -4,7 +4,7 @@ set -e
 # Running Code Linter -- Requires @loopback/build so it's bootstrapped
 if [ $TASK = "code-lint" ]; then
   echo "TASK => LINTING CODE"
-  lerna bootstrap --scope @loopback/build
+  lerna bootstrap --scope @loopback/build --scope @loopback/tslint-config
   npm run lint
 
 # Commit Message Linter

docs/site/DEVELOPING.md

@@ -22,6 +22,7 @@ See [Monorepo overview](./MONOREPO.md) for a list of all packages.
 - [Making breaking changes](#making-breaking-changes)
 - [Releasing new versions](#releasing-new-versions)
 - [Adding a new package](#adding-a-new-package)
+- [Upgrading TypeScript/tslint](#upgrading-typescripttslint)
 - [How to test infrastructure changes](#how-to-test-infrastructure-changes)
 
 ## Setting up development environment
@@ -437,6 +438,27 @@ Please register the new package in the following files:
   [@raymondfeng](https://github.com/raymondfeng) to enlist the new package on
   <http://apidocs.loopback.io/>.
 
+## Upgrading TypeScript/tslint
+
+In order to support tslint extensions with a peer dependency on tslint, we have
+to specify `typescript` and `tslint` dependency in multiple places in our
+monorepo.
+
+Steps to upgrade `typescript` or `tslint` to a newer version:
+
+1. Update the dependencies in `@loopback/build`, this is the source of truth for
+   the rest of the monorepo.
+
+   ```shell
+   $ (cd packages/build && npm update typescript tslint)
+   ```
+
+2. Propagate the change to other places to keep everything consistent.
+
+   ```shell
+   $ node bin/sync-dev-deps
+   ```
+
 ## How to test infrastructure changes
 
 When making changes to project infrastructure, e.g. modifying `tsc` or `tslint`

examples/hello-world/package.json

@@ -43,7 +43,9 @@
     "@loopback/build": "^1.1.0",
     "@loopback/testlab": "^1.0.3",
     "@loopback/tslint-config": "^1.0.0",
-    "@types/node": "^10.11.2"
+    "@types/node": "^10.11.2",
+    "tslint": "^5.12.0",
+    "typescript": "^3.2.2"
   },
   "keywords": [
     "loopback",

examples/log-extension/package.json

@@ -45,7 +45,9 @@
     "@loopback/testlab": "^1.0.3",
     "@loopback/tslint-config": "^1.0.0",
     "@types/debug": "0.0.30",
-    "@types/node": "^10.11.2"
+    "@types/node": "^10.11.2",
+    "tslint": "^5.12.0",
+    "typescript": "^3.2.2"
   },
   "dependencies": {
     "@loopback/context": "^1.4.0",

examples/rpc-server/package.json

@@ -49,6 +49,8 @@
     "@loopback/tslint-config": "^1.0.0",
     "@types/express": "^4.11.1",
     "@types/node": "^10.11.2",
-    "@types/p-event": "^1.3.0"
+    "@types/p-event": "^1.3.0",
+    "tslint": "^5.12.0",
+    "typescript": "^3.2.2"
   }
 }

examples/soap-calculator/package.json

@@ -57,6 +57,8 @@
     "@types/mocha": "^5.0.0",
     "@types/node": "^10.11.2",
     "mocha": "^5.1.1",
-    "source-map-support": "^0.5.5"
+    "source-map-support": "^0.5.5",
+    "tslint": "^5.12.0",
+    "typescript": "^3.2.2"
   }
 }

examples/todo-list/package.json

@@ -53,7 +53,9 @@
     "@loopback/tslint-config": "^1.0.0",
     "@types/lodash": "^4.14.109",
     "@types/node": "^10.11.2",
-    "lodash": "^4.17.10"
+    "lodash": "^4.17.10",
+    "tslint": "^5.12.0",
+    "typescript": "^3.2.2"
   },
   "keywords": [
     "loopback",

examples/todo/package.json

@@ -53,7 +53,9 @@
     "@loopback/tslint-config": "^1.0.0",
     "@types/lodash": "^4.14.109",
     "@types/node": "^10.11.2",
-    "lodash": "^4.17.10"
+    "lodash": "^4.17.10",
+    "tslint": "^5.12.0",
+    "typescript": "^3.2.2"
   },
   "keywords": [
     "loopback",

package.json

@@ -17,13 +17,16 @@
     "coveralls": "^3.0.0",
     "cz-conventional-changelog": "^2.1.0",
     "husky": "^1.2.0",
-    "lerna": "^3.5.1"
+    "lerna": "^3.5.1",
+    "tslint": "^5.12.0",
+    "typescript": "^3.2.2"
   },
   "scripts": {
     "postinstall": "lerna bootstrap",
     "prerelease": "npm run build:full && npm run mocha && npm run lint",
     "release": "lerna version && lerna publish from-git --yes",
     "update-template-deps": "node bin/update-template-deps -f",
+    "sync-dev-deps": "node bin/sync-dev-deps",
     "version": "npm run update-template-deps && npm run apidocs",
     "outdated": "npm outdated --depth 0 && lerna exec --no-bail \"npm outdated --depth 0\"",
     "apidocs": "node bin/run-lerna run build:apidocs",

packages/boot/test/fixtures/application.ts

@@ -10,7 +10,7 @@ import {ServiceMixin} from '@loopback/service-proxy';
 import {BootMixin} from '../..';
 
 // Force package.json to be copied to `dist` by `tsc`
-//tslint:disable-next-line:no-unused-variable
+//tslint:disable-next-line:no-unused
 import * as pkg from './package.json';
 
 export class BooterApp extends BootMixin(

packages/build/package.json

@@ -26,8 +26,8 @@
     "rimraf": "^2.6.2",
     "source-map-support": "^0.5.5",
     "strong-docs": "^4.0.0",
-    "tslint": "^5.9.1",
-    "typescript": "^3.2.1"
+    "tslint": "^5.12.0",
+    "typescript": "^3.2.2"
   },
   "bin": {
     "lb-tsc": "./bin/compile-package.js",

packages/cli/generators/project/templates/package.json.ejs

@@ -93,6 +93,10 @@
     "@loopback/build": "<%= project.dependencies['@loopback/build'] -%>",
     "@loopback/testlab": "<%= project.dependencies['@loopback/testlab'] -%>",
     "@loopback/tslint-config": "<%= project.dependencies['@loopback/tslint-config'] -%>",
-    "@types/node": "<%= project.dependencies['@types/node'] -%>"
+    "@types/node": "<%= project.dependencies['@types/node'] -%>",
+    <% if (project.tslint) { -%>
+    "tslint": "<%= project.dependencies['tslint'] -%>",
+    <% } -%>
+    "typescript": "<%= project.dependencies['typescript'] -%>"
   }
 }

packages/cli/test/integration/lib/project-generator.js

@@ -249,11 +249,12 @@ module.exports = function(projGenerator, props, projectType) {
         assert.jsonFileContent('package.json', props);
         assert.fileContent([
           ['package.json', '@loopback/build'],
+          ['package.json', '"typescript"'],
+          ['package.json', '"tslint"'],
           ['tslint.json', '@loopback/tslint-config'],
           ['tsconfig.json', '@loopback/build'],
         ]);
         assert.noFileContent([
-          ['package.json', '"typescript"'],
           ['tslint.json', '"rules"'],
           ['tsconfig.json', '"compilerOptions"'],
         ]);
@@ -423,6 +424,7 @@ module.exports = function(projGenerator, props, projectType) {
         assert.noFile(['tslint.json', 'tslint.build.json']);
         assert.noFileContent([
           ['package.json', '@loopback/build'],
+          ['package.json', '"tslint"'],
           ['tsconfig.json', '@loopback/build'],
         ]);
         assert.fileContent([

packages/context/src/binding-key.ts

@@ -5,7 +5,7 @@
 
 export type BindingAddress<T> = string | BindingKey<T>;
 
-// tslint:disable-next-line:no-unused-variable
+// tslint:disable-next-line:no-unused
 export class BindingKey<ValueType> {
   static readonly PROPERTY_SEPARATOR = '#';
 

packages/context/src/resolution-session.ts

@@ -13,7 +13,7 @@ const debugSession = debugModule('loopback:context:resolver:session');
 const getTargetName = DecoratorFactory.getTargetName;
 
 // NOTE(bajtos) The following import is required to satisfy TypeScript compiler
-// tslint:disable-next-line:no-unused-variable
+// tslint:disable-next-line:no-unused
 import {BindingKey} from './binding-key';
 
 /**

packages/context/test/unit/inject.unit.ts

@@ -12,7 +12,7 @@ import {
 
 describe('function argument injection', () => {
   it('can decorate class constructor arguments', () => {
-    // tslint:disable-next-line:no-unused-variable
+    // tslint:disable-next-line:no-unused
     class TestClass {
       constructor(@inject('foo') foo: string) {}
     }
@@ -29,7 +29,7 @@ describe('function argument injection', () => {
   });
 
   it('can retrieve information about injected method arguments', () => {
-    // tslint:disable-next-line:no-unused-variable
+    // tslint:disable-next-line:no-unused
     class TestClass {
       test(@inject('foo') foo: string) {}
     }
@@ -97,7 +97,7 @@ describe('function argument injection', () => {
 
 describe('property injection', () => {
   it('can decorate properties', () => {
-    // tslint:disable-next-line:no-unused-variable
+    // tslint:disable-next-line:no-unused
     class TestClass {
       @inject('foo')
       foo: string;
@@ -126,7 +126,7 @@ describe('property injection', () => {
 
   it('cannot decorate static properties', () => {
     expect(() => {
-      // tslint:disable-next-line:no-unused-variable
+      // tslint:disable-next-line:no-unused
       class TestClass {
         @inject('foo')
         static foo: string;
@@ -136,7 +136,7 @@ describe('property injection', () => {
 
   it('cannot decorate a method', () => {
     expect(() => {
-      // tslint:disable-next-line:no-unused-variable
+      // tslint:disable-next-line:no-unused
       class TestClass {
         @inject('bar')
         foo() {}

packages/context/test/unit/resolution-session.unit.ts

@@ -8,7 +8,7 @@ import {ResolutionSession, Binding, Injection, inject} from '../..';
 
 describe('ResolutionSession', () => {
   class MyController {
-    // tslint:disable-next-line:no-unused-variable
+    // tslint:disable-next-line:no-unused
     constructor(@inject('b') private b: string) {}
   }
   function givenInjection(): Injection {

packages/metadata/src/types.ts

@@ -17,6 +17,7 @@ export type DecoratorType =
  * @typeparam T Type of the metadata value
  * @typeparam D Type of the decorator
  */
+// tslint:disable-next-line:no-unused
 export class MetadataAccessor<T, D extends DecoratorType = DecoratorType> {
   private constructor(public readonly key: string) {}
 

packages/metadata/test/unit/decorator-factory.unit.ts

@@ -113,7 +113,7 @@ describe('ClassDecoratorFactory', () => {
     expect(() => {
       @classDecorator({x: 1})
       @classDecorator({y: 2})
-      // tslint:disable-next-line:no-unused-variable
+      // tslint:disable-next-line:no-unused
       class MyController {}
     }).to.throw(
       /Decorator cannot be applied more than once on class MyController/,
@@ -352,7 +352,7 @@ describe('PropertyDecoratorFactory', () => {
 
   it('throws if applied more than once on the same property', () => {
     expect(() => {
-      // tslint:disable-next-line:no-unused-variable
+      // tslint:disable-next-line:no-unused
       class MyController {
         @propertyDecorator({x: 1})
         @propertyDecorator({y: 2})
@@ -400,7 +400,7 @@ describe('PropertyDecoratorFactory for static properties', () => {
 
   it('throws if applied more than once on the same static property', () => {
     expect(() => {
-      // tslint:disable-next-line:no-unused-variable
+      // tslint:disable-next-line:no-unused
       class MyController {
         @propertyDecorator({x: 1})
         @propertyDecorator({y: 2})
@@ -448,7 +448,7 @@ describe('MethodDecoratorFactory', () => {
 
   it('throws if applied more than once on the same method', () => {
     expect(() => {
-      // tslint:disable-next-line:no-unused-variable
+      // tslint:disable-next-line:no-unused
       class MyController {
         @methodDecorator({x: 1})
         @methodDecorator({y: 2})
@@ -496,7 +496,7 @@ describe('MethodDecoratorFactory for static methods', () => {
 
   it('throws if applied more than once on the same static method', () => {
     expect(() => {
-      // tslint:disable-next-line:no-unused-variable
+      // tslint:disable-next-line:no-unused
       class MyController {
         @methodDecorator({x: 1})
         @methodDecorator({y: 2})
@@ -545,7 +545,7 @@ describe('ParameterDecoratorFactory', () => {
 
   it('throws if applied more than once on the same parameter', () => {
     expect(() => {
-      // tslint:disable-next-line:no-unused-variable
+      // tslint:disable-next-line:no-unused
       class MyController {
         myMethod(
           @parameterDecorator({x: 1})
@@ -634,7 +634,7 @@ describe('ParameterDecoratorFactory for a static method', () => {
 
   it('throws if applied more than once on the same parameter', () => {
     expect(() => {
-      // tslint:disable-next-line:no-unused-variable
+      // tslint:disable-next-line:no-unused
       class MyController {
         static myMethod(
           @parameterDecorator({x: 1})
@@ -695,7 +695,7 @@ describe('MethodParameterDecoratorFactory with invalid decorations', () => {
 
   it('reports error if the # of decorations exceeeds the # of params', () => {
     expect(() => {
-      // tslint:disable-next-line:no-unused-variable
+      // tslint:disable-next-line:no-unused
       class MyController {
         @methodParameterDecorator({x: 1}) // Causing error
         @methodParameterDecorator({x: 2}) // For a