Moved "tslint-modular" to the @jsdevtools scope

JamesMessinger · JamesMessinger · commit 3afb3d7ac1bc · 2020-02-09T08:11:10.000-06:00
diff --git a/.github/workflows/CI-CD.yaml b/.github/workflows/CI-CD.yaml
@@ -46,7 +46,7 @@ jobs:
       - name: Link tslint-modular, so TSLint can find it
         run: |
           npm link
-          npm link tslint-modular
+          npm link @jsdevtools/tslint-modular
 
       - name: Run linter
         run: npm run lint
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 Modular TSLint Configuration
-=======================
+===============================
 
 [![Cross-Platform Compatibility](https://jstools.dev/img/badges/os-badges.svg)](https://github.com/JS-DevTools/tslint-modular/blob/master/.github/workflows/CI-CD.yaml)
 [![Build Status](https://github.com/JS-DevTools/tslint-modular/workflows/CI-CD/badge.svg)](https://github.com/JS-DevTools/tslint-modular/blob/master/.github/workflows/CI-CD.yaml)
@@ -10,7 +10,7 @@ Modular TSLint Configuration
 [![npm](https://img.shields.io/npm/v/tslint-modular.svg?maxAge=43200)](https://www.npmjs.com/package/tslint-modular)
 [![License](https://img.shields.io/npm/l/tslint-modular.svg?maxAge=2592000)](LICENSE)
 
-`tslint-modular` is a set of [configuration presets](https://palantir.github.io/tslint/usage/configuration/#configuration-presets) for [TSLint](https://palantir.github.io/tslint/) that's broken-up into different modules that can be mixed-and-matched to match the needs of your project.
+TSLint Modular is a set of [configuration presets](https://palantir.github.io/tslint/usage/configuration/#configuration-presets) for [TSLint](https://palantir.github.io/tslint/) that's broken-up into different modules that can be mixed-and-matched to match the needs of your project.
 
 Each module defines rules that are meant to be reasonable defaults and best practices, but you can easily extend or override any of the rules to suit your needs.
 
@@ -24,10 +24,10 @@ Related Projects
 
 Installation
 -----------------------
-Run the following [npm](https://docs.npmjs.com/about-npm/) command to install [TSLint](https://palantir.github.io/tslint/) and `tslint-modular` as dev-dependencies of your project:
+Run the following [npm](https://docs.npmjs.com/about-npm/) command to install [TSLint](https://palantir.github.io/tslint/) and `@jsdevtools/tslint-modular` as dev-dependencies of your project:
 
 ```bash
-npm install tslint tslint-modular --save-dev
+npm install tslint @jsdevtools/tslint-modular --save-dev
 ```
 
 
@@ -37,16 +37,16 @@ Usage
 Configuration presets are designed to work with the `extends` feature of `tslint.yaml` files. You can learn more about
 [configuration presets](https://palantir.github.io/tslint/usage/configuration/#configuration-presets) on the official TSLint website.
 
-To use `tslint-modular` in your project, create a `tslint.yaml` file with the following contents:
+To use TSLint Modular in your project, create a `tslint.yaml` file with the following contents:
 
 **tslint.yaml**
 ```yaml
 extends:
   # These modules would be good for a library that runs in Node.js and web browsers
-  - tslint-modular/best-practices
-  - tslint-modular/style
-  - tslint-modular/node
-  - tslint-modular/browser
+  - "@jsdevtools/tslint-modular/best-practices"
+  - "@jsdevtools/tslint-modular/style"
+  - "@jsdevtools/tslint-modular/node"
+  - "@jsdevtools/tslint-modular/browser"
 
 rules:
   # You can override or extend the rules here
@@ -56,45 +56,45 @@ rules:
 
 Modules
 -----------------------
-`tslint-modular` includes the following modules.  Mix-and-match them as applicable to your project.
+TSLint Modular includes the following modules.  Mix-and-match them as applicable to your project.
 
-### `tslint-modular/best-practices` <small>[(source)](./best-practices/index.js)</small>
+### `@jsdevtools/tslint-modular/best-practices` <small>[(source)](./best-practices/index.js)</small>
 Contains rules that prevent accidental bugs, insecure code, and bad coding practices.  You can use this module directly, or use any/all of its sub-modules.
 
-#### `tslint-modular/best-practices/bugs` <small>[(source)](./best-practices/bugs.js)</small>
+#### `@jsdevtools/tslint-modular/best-practices/bugs` <small>[(source)](./best-practices/bugs.js)</small>
 Prevents syntax that is likely to lead to accidental bugs or runtime errors.  Examples include not [duplicate variables](https://palantir.github.io/tslint/rules/no-duplicate-variable/), and [using `===` instead of `==`](https://palantir.github.io/tslint/rules/triple-equals) for comparisons. Most of the rules in this file will raise an error if violated, but some less-severe ones will only raise warnings.
 
-#### `tslint-modular/best-practices/maintainability` <small>[(source)](./best-practices/maintainability.js)</small>
+#### `@jsdevtools/tslint-modular/best-practices/maintainability` <small>[(source)](./best-practices/maintainability.js)</small>
 Helps you write code that is more maintainable over time and by multiple people.  For example, [limiting cyclomatic complexity](https://palantir.github.io/tslint/rules/cyclomatic-complexity) and [keeping files short](https://palantir.github.io/tslint/rules/max-file-line-count).
 
-#### `tslint-modular/best-practices/security` <small>[(source)](./best-practices/security.js)</small>
+#### `@jsdevtools/tslint-modular/best-practices/security` <small>[(source)](./best-practices/security.js)</small>
 Helps enforce security best-practices such as [avoiding the `eval()` statement](https://palantir.github.io/tslint/rules/no-eval) and [not calling the `Function` constructor](https://palantir.github.io/tslint/rules/function-constructor).
 
-### `tslint-modular/browser` <small>[(source)](./browser/index.js)</small>
+### `@jsdevtools/tslint-modular/browser` <small>[(source)](./browser/index.js)</small>
 Bans bad practices for web-based code, such as [the `alert()` statement](https://eslint.org/docs/rules/no-alert#disallow-use-of-alert-no-alert) and the jQuery global.
 
-### `tslint-modular/node` <small>[(source)](./node/index.js)</small>
+### `@jsdevtools/tslint-modular/node` <small>[(source)](./node/index.js)</small>
 Discourages deprecated and outdated Node.js code, such as [`fs.exists()`](https://nodejs.org/api/fs.html#fs_fs_exists_path_callback). It encourages using more modern syntax, such as [the `fs.promises` API](https://nodejs.org/api/fs.html#fs_fs_promises_api).
 
-### `tslint-modular/style` <small>[(source)](./style/index.js)</small>
+### `@jsdevtools/tslint-modular/style` <small>[(source)](./style/index.js)</small>
 Contains code-styling and consistency rules.    You can use this module directly, or use any/all of its sub-modules.
 
-#### `tslint-modular/style/comments` <small>[(source)](./style/comments.js)</small>
+#### `@jsdevtools/tslint-modular/style/comments` <small>[(source)](./style/comments.js)</small>
 Code-commenting rules, such as [documenting all public members](https://palantir.github.io/tslint/rules/completed-docs/), using [JSDoc format](https://palantir.github.io/tslint/rules/jsdoc-format/), and not [duplicating type information](https://palantir.github.io/tslint/rules/no-redundant-jsdoc/) in comments.
 
-#### `tslint-modular/style/conventions` <small>[(source)](./style/conventions.js)</small>
+#### `@jsdevtools/tslint-modular/style/conventions` <small>[(source)](./style/conventions.js)</small>
 Enforces an **opinionated** set of conventions, such as using [double-quotes](https://palantir.github.io/tslint/rules/quotemark/) and [semi-colons](https://palantir.github.io/tslint/rules/semicolon).
 
-#### `tslint-modular/style/naming` <small>[(source)](./style/naming.js)</small>
+#### `@jsdevtools/tslint-modular/style/naming` <small>[(source)](./style/naming.js)</small>
 Encourages good JavaScript naming conventions, such as [camel-case variables](https://palantir.github.io/tslint/rules/variable-name) and [capitialized classes](https://palantir.github.io/tslint/rules/class-name).
 
-#### `tslint-modular/style/syntax` <small>[(source)](./style/syntax.js)</small>
+#### `@jsdevtools/tslint-modular/style/syntax` <small>[(source)](./style/syntax.js)</small>
 Disallows outdated, nonstandard, and confusing syntax.  Examples include [labels](https://palantir.github.io/tslint/rules/label-position), [the comma operator](https://palantir.github.io/tslint/rules/ban-comma-operator), and [parameter properties](https://palantir.github.io/tslint/rules/no-parameter-properties).
 
-#### `tslint-modular/style/whitespace` <small>[(source)](./style/whitespace.js)</small>
+#### `@jsdevtools/tslint-modular/style/whitespace` <small>[(source)](./style/whitespace.js)</small>
 Enforces **opinionated** whitespace rules, such as [two-space indentation](https://palantir.github.io/tslint/rules/indent), [opening braces on the same line](https://palantir.github.io/tslint/rules/one-line), and [type definition spacing](https://palantir.github.io/tslint/rules/typedef-whitespace).
 
-### `tslint-modular/test` <small>[(source)](./test/index.js)</small>
+### `@jsdevtools/tslint-modular/test` <small>[(source)](./test/index.js)</small>
 Warns about `describe.only()` and `it.only()` calls that may have accidentally been left in your test code.
 
 > **Note:** We recommend that you create a separate `tslint.yaml` file in your test folder. That way, it can use different modules and rules than the rest of your codebase.
diff --git a/best-practices/index.js b/best-practices/index.js
@@ -2,8 +2,8 @@
 
 module.exports = {
   extends: [
-    "tslint-modular/best-practices/bugs",
-    "tslint-modular/best-practices/maintainability",
-    "tslint-modular/best-practices/security",
+    "@jsdevtools/tslint-modular/best-practices/bugs",
+    "@jsdevtools/tslint-modular/best-practices/maintainability",
+    "@jsdevtools/tslint-modular/best-practices/security",
   ]
 };
diff --git a/index.js b/index.js
@@ -2,9 +2,9 @@
 
 module.exports = {
   extends: [
-    "tslint-modular/best-practices",
-    "tslint-modular/style",
-    "tslint-modular/browser",
-    "tslint-modular/node",
+    "@jsdevtools/tslint-modular/best-practices",
+    "@jsdevtools/tslint-modular/style",
+    "@jsdevtools/tslint-modular/browser",
+    "@jsdevtools/tslint-modular/node",
   ],
 };
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "tslint-modular",
+  "name": "@jsdevtools/tslint-modular",
   "version": "1.6.1",
   "description": "Modular TSLint configuration",
   "keywords": [
diff --git a/style/index.js b/style/index.js
@@ -2,10 +2,10 @@
 
 module.exports = {
   extends: [
-    "tslint-modular/style/comments",
-    "tslint-modular/style/conventions",
-    "tslint-modular/style/naming",
-    "tslint-modular/style/syntax",
-    "tslint-modular/style/whitespace",
+    "@jsdevtools/tslint-modular/style/comments",
+    "@jsdevtools/tslint-modular/style/conventions",
+    "@jsdevtools/tslint-modular/style/naming",
+    "@jsdevtools/tslint-modular/style/syntax",
+    "@jsdevtools/tslint-modular/style/whitespace",
   ]
 };
diff --git a/test/specs/best-practices.spec.js b/test/specs/best-practices.spec.js
@@ -4,20 +4,20 @@ const TSLint = require("../utils/tslint");
 const chai = require("chai");
 chai.should();
 
-describe("tslint-modular/best-practices", () => {
+describe("@jsdevtools/tslint-modular/best-practices", () => {
   it("should not be enforced if module is not used", () => {
     let results = TSLint.run(
-      "tslint-modular/browser",
+      "@jsdevtools/tslint-modular/browser",
       "Date.now() == Date.now();"
     );
 
     results.errors.should.deep.equal([]);
     results.warnings.should.deep.equal([]);
   });
 
-  it("should include tslint-modular/best-practices/bugs", () => {
+  it("should include @jsdevtools/tslint-modular/best-practices/bugs", () => {
     let results = TSLint.run(
-      "tslint-modular/best-practices",
+      "@jsdevtools/tslint-modular/best-practices",
       `
       Date.now() == Date.now();
       interface Foo {}
@@ -36,9 +36,9 @@ describe("tslint-modular/best-practices", () => {
     results.warnings.should.deep.equal([]);
   });
 
-  it("should include tslint-modular/best-practices/maintainability", () => {
+  it("should include best-practices/maintainability", () => {
     let results = TSLint.run(
-      "tslint-modular/best-practices",
+      "@jsdevtools/tslint-modular/best-practices",
       `
       import { readFile } from "fs";
       import { writeFile } from "fs";
@@ -68,9 +68,9 @@ describe("tslint-modular/best-practices", () => {
     results.warnings.should.deep.equal([]);
   });
 
-  it("should include tslint-modular/best-practices/security", () => {
+  it("should include best-practices/security", () => {
     let results = TSLint.run(
-      "tslint-modular/best-practices",
+      "@jsdevtools/tslint-modular/best-practices",
       `
       eval("x = 5");
       let x = Function("x = 5");
diff --git a/test/specs/browser.spec.js b/test/specs/browser.spec.js
@@ -4,10 +4,10 @@ const TSLint = require("../utils/tslint");
 const chai = require("chai");
 chai.should();
 
-describe("tslint-modular/browser", () => {
+describe("@jsdevtools/tslint-modular/browser", () => {
   it("should not be enforced if module is not used", () => {
     let results = TSLint.run(
-      "tslint-modular/node",
+      "@jsdevtools/tslint-modular/node",
       `
       var name = window.prompt("What's your name?");
       alert("hello, " + name);
@@ -20,7 +20,7 @@ describe("tslint-modular/browser", () => {
 
   it("should warn about alert(), confirm(), and prompt()", () => {
     let results = TSLint.run(
-      "tslint-modular/browser",
+      "@jsdevtools/tslint-modular/browser",
       `
       var answer = window.prompt("What's your name?");
       if (confirm("Are you sure it's " + answer)) {
diff --git a/test/specs/node.spec.js b/test/specs/node.spec.js
@@ -4,10 +4,10 @@ const TSLint = require("../utils/tslint");
 const chai = require("chai");
 chai.should();
 
-describe("tslint-modular/node", () => {
+describe("@jsdevtools/tslint-modular/node", () => {
   it("should not be enforced if module is not used", () => {
     let results = TSLint.run(
-      "tslint-modular/browser",
+      "@jsdevtools/tslint-modular/browser",
       `
       const fs = require("fs");
       const file = "some-file.txt";
@@ -30,7 +30,7 @@ describe("tslint-modular/node", () => {
 
   it("should warn about fs.exists() and callback versions of fs functions", () => {
     let results = TSLint.run(
-      "tslint-modular/node",
+      "@jsdevtools/tslint-modular/node",
       `
       const fs = require("fs");
       const file = "some-file.txt";
diff --git a/test/specs/style.spec.js b/test/specs/style.spec.js
@@ -4,10 +4,10 @@ const TSLint = require("../utils/tslint");
 const chai = require("chai");
 chai.should();
 
-describe("tslint-modular/style", () => {
+describe("@jsdevtools/tslint-modular/style", () => {
   it("should not be enforced if module is not used", () => {
     let results = TSLint.run(
-      "tslint-modular/best-practices",
+      "@jsdevtools/tslint-modular/best-practices",
       `
       /**Does a thing
        * and returns a value */
@@ -24,9 +24,9 @@ describe("tslint-modular/style", () => {
     results.warnings.should.deep.equal([]);
   });
 
-  it("should include tslint-modular/style/comments", () => {
+  it("should include style/comments", () => {
     let results = TSLint.run(
-      "tslint-modular/style",
+      "@jsdevtools/tslint-modular/style",
       `
       /**Does a thing
        * and returns a value
@@ -48,9 +48,9 @@ describe("tslint-modular/style", () => {
     results.warnings.should.deep.equal([]);
   });
 
-  it("should include tslint-modular/style/conventions", () => {
+  it("should include style/conventions", () => {
     let results = TSLint.run(
-      "tslint-modular/style",
+      "@jsdevtools/tslint-modular/style",
       `
       function foo(x: string[][], y: number = 5): Array<string> {
         return x[0].sort(a => { return y });
@@ -86,9 +86,9 @@ describe("tslint-modular/style", () => {
     results.warnings.should.deep.equal([]);
   });
 
-  it("should include tslint-modular/style/naming", () => {
+  it("should include style/naming", () => {
     let results = TSLint.run(
-      "tslint-modular/style",
+      "@jsdevtools/tslint-modular/style",
       `
       interface IClass {
         name: string;
@@ -116,9 +116,9 @@ describe("tslint-modular/style", () => {
     results.warnings.should.deep.equal([]);
   });
 
-  it("should include tslint-modular/style/syntax", () => {
+  it("should include style/syntax", () => {
     let results = TSLint.run(
-      "tslint-modular/style",
+      "@jsdevtools/tslint-modular/style",
       `
       /// <reference path="fs" />
       import fs from "fs";
@@ -156,9 +156,9 @@ describe("tslint-modular/style", () => {
     ]);
   });
 
-  it("should include tslint-modular/style/whitespace", () => {
+  it("should include style/whitespace", () => {
     let results = TSLint.run(
-      "tslint-modular/style",
+      "@jsdevtools/tslint-modular/style",
       `
       import{readFile}from "fs";
 
diff --git a/test/specs/test.spec.js b/test/specs/test.spec.js
@@ -4,10 +4,10 @@ const TSLint = require("../utils/tslint");
 const chai = require("chai");
 chai.should();
 
-describe("tslint-modular/test", () => {
+describe("@jsdevtools/tslint-modular/test", () => {
   it("should not be enforced if module is not used", () => {
     let results = TSLint.run(
-      "tslint-modular",
+      "@jsdevtools/tslint-modular",
       `
       describe.only("My test suite", () => {
         it.only("My test", () => {
@@ -23,7 +23,7 @@ describe("tslint-modular/test", () => {
 
   it("should warn about describe.only() and it.only()", () => {
     let results = TSLint.run(
-      "tslint-modular/test",
+      "@jsdevtools/tslint-modular/test",
       `
       describe.only("My test suite", () => {
         it.only("My test", () => {
diff --git a/test/specs/tslint.spec.js b/test/specs/tslint.spec.js
@@ -4,14 +4,14 @@ const TSLint = require("../utils/tslint");
 const chai = require("chai");
 chai.should();
 
-describe("tslint-modular", () => {
+describe("@jsdevtools/tslint-modular", () => {
   /**
    * This test just verifies that TSLint runs without errors,
    * which means that all of our modules are syntactically valid
    */
   it("should run without errors", () => {
     let results = TSLint.run(
-      "tslint-modular",
+      "@jsdevtools/tslint-modular",
       `
       /**
        * My Class
@@ -39,7 +39,7 @@ describe("tslint-modular", () => {
    */
   it("should report errors for rule violations", () => {
     let results = TSLint.run(
-      "tslint-modular",
+      "@jsdevtools/tslint-modular",
       `
       export default class my_class {
         method1 (x) {}
@@ -82,7 +82,7 @@ describe("tslint-modular", () => {
    */
   it("should include all TSLint rules", () => {
     let allRules = Object.keys(require("tslint/lib/configs/all").rules);
-    let ourRules = getRulesRecursive("tslint-modular");
+    let ourRules = getRulesRecursive("@jsdevtools/tslint-modular");
 
     for (let rule of allRules) {
       ourRules.should.contain(rule);

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "tslint-modular",`
	`2`	`+ "name": "@jsdevtools/tslint-modular",`
`3`	`3`	`"version": "1.6.1",`
`4`	`4`	`"description": "Modular TSLint configuration",`
`5`	`5`	`"keywords": [`