@definitelytyped/dtslint 0.0.95-next.1

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,177 @@
+`dtslint` tests a TypeScript declaration file for style and correctness.
+It will install `typescript` and `tslint` for you, so this is the only tool you need to test a type definition.
+
+Lint rules new to dtslint are documented in the [docs](docs) directory.
+
+# Just looking for ExpectType and ExpectError?
+
+[Use tsd instead](https://github.com/SamVerschueren/tsd).
+
+# Setup
+
+If you are working on DefinitelyTyped, read the [DefinitelyTyped README](https://github.com/DefinitelyTyped/DefinitelyTyped#readme).
+
+If you are writing the library in TypeScript, don't use `dtslint`.
+Use [`--declaration`](http://www.typescriptlang.org/docs/handbook/compiler-options.html) to have type definitions generated for you.
+
+If you are a library author, read below.
+
+
+## Add types for a library (not on DefinitelyTyped)
+
+[`dts-gen`](https://github.com/Microsoft/dts-gen#readme) may help, but is not required.
+
+Create a `types` directory. (Name is arbitrary.)
+Add `"types": "types"` to your `package.json`.
+Read more on bundling types [here](http://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html).
+
+
+#### `types/index.d.ts`
+
+Only `index.d.ts` needs to be published to NPM. Other files are just for testing.
+Write your type definitions here.
+Refer to the [handbook](http://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html) or `dts-gen`'s templates for how to do this.
+
+
+#### `types/tsconfig.json`
+
+```json5
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": ["es6"],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true,
+
+        // If the library is an external module (uses `export`), this allows your test file to import "mylib" instead of "./index".
+        // If the library is global (cannot be imported via `import` or `require`), leave this out.
+        "baseUrl": ".",
+        "paths": { "mylib": ["."] }
+    }
+}
+```
+
+You may extend `"lib"` to, for example, `["es6", "dom"]` if you need those typings.
+You may also have to add `"target": "es6"` if using certain language features.
+
+
+#### `types/tslint.json`
+
+If you are using the default rules, this is optional.
+
+If present, this will override `dtslint`'s [default](https://github.com/Microsoft/dtslint/blob/master/dtslint.json) settings.
+You can specify new lint [rules](https://palantir.github.io/tslint/rules/), or disable some. An example:
+
+```json5
+{
+    "extends": "dtslint/dtslint.json", // Or "dtslint/dt.json" if on DefinitelyTyped
+    "rules": {
+        "semicolon": false,
+        "indent": [true, "tabs"]
+    }
+}
+```
+
+
+#### `types/test.ts`
+
+You can have any number of test files you want, with any names. See below on what to put in them.
+
+
+
+## Write tests
+
+A test file should be a piece of sample code that tests using the library. Tests are type-checked, but not run.
+To assert that an expression is of a given type, use `$ExpectType`.
+To assert that an expression causes a compile error, use `$ExpectError`.
+(Assertions will be checked by the `expect` lint rule.)
+
+```ts
+import { f } from "my-lib"; // f is(n: number) => void
+
+// $ExpectType void
+f(1);
+
+// Can also write the assertion on the same line.
+f(2); // $ExpectType void
+
+// $ExpectError
+f("one");
+```
+
+
+## Specify a TypeScript version
+
+Normally packages will be tested using TypeScript 2.0.
+To use a newer version, specify it by including a comment like so:
+
+```ts
+// Minimum TypeScript Version: 2.1
+```
+
+For DefinitelyTyped packages, this should go just under the header (on line 5).
+For bundled typings, this can go on any line (but should be near the top).
+
+
+## Run tests
+
+- `npm install --save-dev dtslint`
+- Add to your `package.json` `scripts`: `"dtslint": "dtslint types"`
+- `npm run dtslint`
+
+### Options
+
+- `--localTs`
+
+Use your locally installed version of TypeScript.
+
+```sh
+dtslint --localTs node_modules/typescript/lib types
+```
+- `--expectOnly`
+
+Disable all the lint rules except the one that checks for type correctness.
+
+```sh
+dtslint --expectOnly types
+```
+
+
+# Contributing
+
+## Build
+
+```sh
+npm link . # Global 'dts-lint' should now refer to this.
+npm run watch
+```
+
+## Test
+
+Use `npm run test` to run all tests.
+To run a single test: `node node_modules/tslint/bin/tslint --rules-dir bin/rules --test test/expect`.
+
+## Publish
+
+1. Change the version in the `package.json`
+2. Push to master
+
+## Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+## FAQ
+I'm getting an error about a missing typescript install.
+```
+Error: Cannot find module '/node_modules/dtslint/typescript-installs/3.1/node_modules/typescript`
+```
+Your dependencies may be out of date.
+[@definitelytyped/typescript-versions](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/typescript-versions) is the package that contains the list of TypeScript versions to install.
+
+Alternatively this error can be caused by concurrent dtslint invocations trampling each other's TypeScript installations, especially in the context of continuous integration, if dtslint is installed from scratch in each run.
+If for example you use [Lerna](https://github.com/lerna/lerna/tree/main/commands/run#readme), try running dtslint with [`lerna --concurrency 1 run ...`](https://github.com/lerna/lerna/tree/main/core/global-options#--concurrency).

package/dt.json

@@ -0,0 +1,15 @@
+{
+	"extends": "./dtslint.json",
+	"rules": {
+		"dt-header": true,
+		"no-bad-reference": true,
+		"no-declare-current-package": true,
+		"no-self-import": true,
+		"no-outside-dependencies": true,
+
+		"no-redundant-jsdoc": false,
+		"no-redundant-jsdoc-2": true,
+
+		"npm-naming": [true, { "mode": "code" }]
+	}
+}

package/dtslint-expect-only.json

@@ -0,0 +1,6 @@
+{
+    "rulesDirectory": "./bin/rules",
+    "rules": {
+        "expect": true
+    }
+}

package/dtslint.json

@@ -0,0 +1,131 @@
+{
+    "extends": "tslint:all",
+    "rulesDirectory": "./bin/rules",
+    "rules": {
+        // Custom rules
+        "expect": true,
+        "export-just-namespace": true,
+        "no-bad-reference": true,
+        "no-const-enum": true,
+        "no-dead-reference": true,
+        "no-import-default-of-export-equals": true,
+        "no-padding": true,
+        "redundant-undefined": true,
+        "no-relative-import-in-test": true,
+        "strict-export-declare-modifiers": true,
+        "no-any-union": true,
+        "no-single-declare-module": true,
+        "no-unnecessary-generics": true,
+        "no-useless-files": true,
+        "prefer-declare-function": true,
+        "trim-file": true,
+        "unified-signatures": true,
+        "void-return": true,
+        "npm-naming": true,
+
+        "comment-format": [true, "check-space"], // But not check-uppercase or check-lowercase
+        "interface-name": [true, "never-prefix"],
+        "max-line-length": [true, 200],
+        "member-access": [true, "no-public"],
+        "no-consecutive-blank-lines": true,
+        "no-unnecessary-callback-wrapper": true,
+        "no-namespace": [true, "allow-declarations"],
+        "object-literal-key-quotes": [true, "as-needed"],
+        "one-line": [
+            true,
+            "check-catch",
+            "check-finally",
+            "check-else",
+            "check-open-brace",
+            "check-whitespace"
+        ],
+        "one-variable-per-declaration": [true, "ignore-for-loop"],
+        "only-arrow-functions": [true, "allow-declarations", "allow-named-functions"],
+        "prefer-template": [true, "allow-single-concat"],
+        "whitespace": [
+            true,
+            "check-branch",
+            "check-decl",
+            "check-operator",
+            "check-module",
+            "check-separator",
+            "check-type",
+            "check-typecast"
+        ],
+
+        // TODO?
+        "align": false, // TODO
+        "arrow-parens": false,
+        "arrow-return-shorthand": true, // TODO: "multiline"
+        "linebreak-style": false, // TODO
+        "no-void-expression": [true, "ignore-arrow-function-shorthand"],
+        "no-any": false, // TODO
+        "no-floating-promises": false, // TODO: https://github.com/palantir/tslint/issues/2879
+        "no-import-side-effect": false,
+        "no-this-assignment": false,
+        "no-unbound-method": false, // TODO?
+        "no-unsafe-any": false, // TODO
+        "no-restricted-globals": false,
+        "number-literal-format": false, // TODO
+        "promise-function-async": false,
+        "restrict-plus-operands": false, // TODO
+        "return-undefined": false, // TODO
+        "switch-final-break": false, // TODO
+        "prefer-method-signature": false, // TODO?
+
+        // Pretty sure we don't want these
+        "binary-expression-operand-order": false,
+        "class-name": false,
+        "completed-docs": false,
+        "curly": false,
+        "cyclomatic-complexity": false,
+        "deprecation": false,
+        "file-name-casing": false,
+        "forin": false,
+        "indent": false,
+        "match-default-export-name": false,
+        "max-classes-per-file": false,
+        "max-file-line-count": false,
+        "member-ordering": false,
+        "newline-before-return": false,
+        "newline-per-chained-call": false,
+        "no-bitwise": false,
+        "no-console": false,
+        "no-default-export": false,
+        "no-empty": false,
+        "no-implicit-dependencies": false, // See https://github.com/palantir/tslint/issues/3364
+        "no-inferred-empty-object-type": false,
+        "no-magic-numbers": false,
+        "no-non-null-assertion": false,
+        "no-null-keyword": false,
+        "no-parameter-properties": false,
+        "no-parameter-reassignment": false,
+        "no-reference": false, // But see no-bad-reference
+        "no-require-imports": false,
+        "no-shadowed-variable": false,
+        "no-string-literal": false,
+        "no-submodule-imports": false,
+        "no-tautology-expression": false,
+        "no-unused-expression": false,
+        "no-unused-variable": false,
+        "no-use-before-declare": false,
+        "object-literal-sort-keys": false,
+        "ordered-imports": false,
+        "prefer-function-over-method": false,
+        "quotemark": false,
+        "strict-boolean-expressions": false,
+        "strict-type-predicates": false,
+        "switch-default": false,
+        "trailing-comma": false,
+        "triple-equals": [true, "allow-null-check"],
+        "typedef": false,
+        "type-literal-delimiter": false,
+        "variable-name": false,
+        "increment-decrement": false,
+        "unnecessary-constructor": false,
+        "unnecessary-else": false,
+        "no-angle-bracket-type-assertion": false,
+        "no-default-import": false,
+        "callable-types": false
+    }
+}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@definitelytyped/dtslint",
+  "version": "0.0.95-next.1",
+  "description": "Runs tests on TypeScript definition files",
+  "files": [
+    "bin",
+    "dt.json",
+    "dtslint.json",
+    "dtslint-expect-only.json"
+  ],
+  "main": "bin",
+  "bin": "./bin/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "contributors": [
+    "Nathan Shively-Sanders <nathansa@microsoft.com> (https://github.com/sandersn)",
+    "Andy Hanson <andy-ms@microsoft.com> (https://github.com/andy-ms)",
+    "Dan Vanderkam <danvdk@gmail.com> (https://github.com/danvk)"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/DefinitelyTyped-tools.git"
+  },
+  "scripts": {
+    "watch": "tsc --watch",
+    "build": "tsc",
+    "lint": "eslint --ext ts src",
+    "test": "npm run build && node test/test.js"
+  },
+  "dependencies": {
+    "@definitelytyped/dts-critic": "^0.0.95-next.1",
+    "@definitelytyped/header-parser": "0.0.93",
+    "@definitelytyped/typescript-versions": "0.0.93",
+    "@definitelytyped/utils": "0.0.93",
+    "fs-extra": "^6.0.1",
+    "json-stable-stringify": "^1.0.1",
+    "strip-json-comments": "^2.0.1",
+    "tslint": "5.14.0",
+    "yargs": "^15.1.0"
+  },
+  "peerDependencies": {
+    "typescript": ">= 3.0.0-dev || >= 3.1.0-dev || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.7.0-dev || >= 3.8.0-dev || >= 3.9.0-dev || >= 4.0.0-dev"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^5.0.2",
+    "@types/json-stable-stringify": "^1.0.32",
+    "@types/node": "14.0.x",
+    "@types/strip-json-comments": "^0.0.28",
+    "@types/yargs": "^15.0.3",
+    "@typescript-eslint/eslint-plugin": "^4.11.1",
+    "@typescript-eslint/parser": "^4.11.1",
+    "eslint": "^7.16.0",
+    "typescript": "next"
+  },
+  "engines": {
+    "node": ">=10.0.0"
+  },
+  "license": "MIT",
+  "gitHead": "dc40b825ec231899cb63a5b007da08c463f2ee7d"
+}