@definitelytyped/eslint-plugin 0.0.206 → 0.0.207

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @definitelytyped/eslint-plugin
 
+## 0.0.207
+
+### Patch Changes
+
+- 57628b68: Add new no-type-only-packages lint rule
+
 ## 0.0.206
 
 ### Patch Changes

package/dist/rules/index.d.ts

@@ -24,4 +24,5 @@ export declare const rules: {
             readonly path: string;
         }[] | undefined;
     }], "noTsconfig" | "twoAssertions" | "failure" | "diagnostic" | "programContents" | "noMatch" | "needInstall">;
+    "no-type-only-packages": import("../util").RuleModule<never[], "onlyTypes">;
 };

package/dist/rules/index.js

@@ -21,6 +21,7 @@ const noOldDTHeader = require("./no-old-dt-header");
 const noImportOfDevDependencies = require("./no-import-of-dev-dependencies");
 const npmNaming = require("./npm-naming");
 const expect = require("./expect");
+const noTypeOnlyPackages = require("./no-type-only-packages");
 exports.rules = {
     "export-just-namespace": exportJustNamespace,
     "no-any-union": noAnyUnion,
@@ -42,5 +43,6 @@ exports.rules = {
     "no-import-of-dev-dependencies": noImportOfDevDependencies,
     "npm-naming": npmNaming,
     expect,
+    "no-type-only-packages": noTypeOnlyPackages,
 };
 //# sourceMappingURL=index.js.map

package/dist/rules/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":";;;AAAA,+DAAgE;AAChE,6CAA8C;AAC9C,qDAAsD;AACtD,+CAAgD;AAChD,uDAAwD;AACxD,wEAAyE;AACzE,sFAAuF;AACvF,uEAAwE;AACxE,iDAAkD;AAClD,2EAA4E;AAC5E,mEAAoE;AACpE,qDAAsD;AACtD,mEAAoE;AACpE,4DAA6D;AAC7D,kFAAmF;AACnF,oEAAqE;AACrE,oDAAqD;AACrD,6EAA8E;AAC9E,0CAA2C;AAC3C,mCAAoC;AAEvB,QAAA,KAAK,GAAG;IACnB,uBAAuB,EAAE,mBAAmB;IAC5C,cAAc,EAAE,UAAU;IAC1B,kBAAkB,EAAE,cAAc;IAClC,eAAe,EAAE,WAAW;IAC5B,mBAAmB,EAAE,eAAe;IACpC,4BAA4B,EAAE,uBAAuB;IACrD,oCAAoC,EAAE,6BAA6B;IACnE,4BAA4B,EAAE,sBAAsB;IACpD,gBAAgB,EAAE,YAAY;IAC9B,8BAA8B,EAAE,wBAAwB;IACxD,yBAAyB,EAAE,qBAAqB;IAChD,kBAAkB,EAAE,cAAc;IAClC,yBAAyB,EAAE,qBAAqB;IAChD,qBAAqB,EAAE,kBAAkB;IACzC,iCAAiC,EAAE,4BAA4B;IAC/D,0BAA0B,EAAE,qBAAqB;IACjD,kBAAkB,EAAE,aAAa;IACjC,+BAA+B,EAAE,yBAAyB;IAC1D,YAAY,EAAE,SAAS;IACvB,MAAM;CACP,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":";;;AAAA,+DAAgE;AAChE,6CAA8C;AAC9C,qDAAsD;AACtD,+CAAgD;AAChD,uDAAwD;AACxD,wEAAyE;AACzE,sFAAuF;AACvF,uEAAwE;AACxE,iDAAkD;AAClD,2EAA4E;AAC5E,mEAAoE;AACpE,qDAAsD;AACtD,mEAAoE;AACpE,4DAA6D;AAC7D,kFAAmF;AACnF,oEAAqE;AACrE,oDAAqD;AACrD,6EAA8E;AAC9E,0CAA2C;AAC3C,mCAAoC;AACpC,8DAA+D;AAElD,QAAA,KAAK,GAAG;IACnB,uBAAuB,EAAE,mBAAmB;IAC5C,cAAc,EAAE,UAAU;IAC1B,kBAAkB,EAAE,cAAc;IAClC,eAAe,EAAE,WAAW;IAC5B,mBAAmB,EAAE,eAAe;IACpC,4BAA4B,EAAE,uBAAuB;IACrD,oCAAoC,EAAE,6BAA6B;IACnE,4BAA4B,EAAE,sBAAsB;IACpD,gBAAgB,EAAE,YAAY;IAC9B,8BAA8B,EAAE,wBAAwB;IACxD,yBAAyB,EAAE,qBAAqB;IAChD,kBAAkB,EAAE,cAAc;IAClC,yBAAyB,EAAE,qBAAqB;IAChD,qBAAqB,EAAE,kBAAkB;IACzC,iCAAiC,EAAE,4BAA4B;IAC/D,0BAA0B,EAAE,qBAAqB;IACjD,kBAAkB,EAAE,aAAa;IACjC,+BAA+B,EAAE,yBAAyB;IAC1D,YAAY,EAAE,SAAS;IACvB,MAAM;IACN,uBAAuB,EAAE,kBAAkB;CAC5C,CAAC"}

package/dist/rules/no-type-only-packages.d.ts

@@ -0,0 +1,2 @@
+declare const rule: import("../util").RuleModule<never[], "onlyTypes">;
+export = rule;

package/dist/rules/no-type-only-packages.js

@@ -0,0 +1,143 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const util_1 = require("../util");
+const utils_1 = require("@typescript-eslint/utils");
+const ts = __importStar(require("typescript"));
+const path_1 = __importDefault(require("path"));
+const rule = (0, util_1.createRule)({
+    name: "no-type-only-packages",
+    defaultOptions: [],
+    meta: {
+        type: "problem",
+        docs: {
+            description: "Forbids type-only packages",
+        },
+        messages: {
+            onlyTypes: "Packages should contain value components, not just types.",
+        },
+        schema: [],
+    },
+    create(context) {
+        if (!(0, util_1.isMainFile)(context.filename, true)) {
+            return {};
+        }
+        const pkg = (0, util_1.findTypesPackage)(context.filename);
+        if (!pkg) {
+            return {};
+        }
+        const program = utils_1.ESLintUtils.getParserServices(context).program;
+        let hasValueDeclaration = false;
+        let hasNonEmptyFile = false;
+        function isOutsidePackage(fileName) {
+            return fileName.includes("node_modules") || path_1.default.relative(pkg.dir, fileName).startsWith("..");
+        }
+        for (const sourceFile of program.getSourceFiles()) {
+            if (!sourceFile.isDeclarationFile ||
+                sourceFile.statements.length === 0 ||
+                isOutsidePackage(sourceFile.fileName)) {
+                continue;
+            }
+            hasNonEmptyFile = true;
+            function isValueDeclaration(node) {
+                switch (node.kind) {
+                    case ts.SyntaxKind.VariableDeclaration:
+                    case ts.SyntaxKind.FunctionDeclaration:
+                    case ts.SyntaxKind.ClassDeclaration:
+                    case ts.SyntaxKind.EnumDeclaration:
+                        return true;
+                }
+                return false;
+            }
+            function getSymbol(node) {
+                const checker = program.getTypeChecker();
+                let symbol = checker.getSymbolAtLocation(node);
+                if (symbol && symbol.flags & ts.SymbolFlags.Alias) {
+                    symbol = checker.getAliasedSymbol(symbol);
+                }
+                return symbol;
+            }
+            function symbolIsValue(node) {
+                const symbol = getSymbol(node);
+                if (symbol) {
+                    return !!symbol.valueDeclaration;
+                }
+                return undefined;
+            }
+            function symbolDefinedOutsidePackage(node) {
+                var _a, _b, _c;
+                return ((_c = (_b = (_a = getSymbol(node)) === null || _a === void 0 ? void 0 : _a.getDeclarations()) === null || _b === void 0 ? void 0 : _b.some((declaration) => isOutsidePackage(declaration.getSourceFile().fileName))) !== null && _c !== void 0 ? _c : false);
+            }
+            function containsValueDeclaration(node) {
+                var _a, _b, _c, _d;
+                if (isValueDeclaration(node)) {
+                    return true;
+                }
+                if (ts.isImportDeclaration(node) || ts.isImportEqualsDeclaration(node)) {
+                    return false;
+                }
+                if (ts.isExportAssignment(node)) {
+                    return (_a = symbolIsValue(node.expression)) !== null && _a !== void 0 ? _a : ts.isLiteralTypeLiteral(node.expression);
+                }
+                if (ts.isNamespaceExportDeclaration(node)) {
+                    return (_b = symbolIsValue(node.name)) !== null && _b !== void 0 ? _b : false;
+                }
+                if (ts.isNamedExports(node)) {
+                    return node.elements.some((element) => symbolIsValue(element.name));
+                }
+                if (ts.isExportDeclaration(node) && !node.isTypeOnly && !node.exportClause && node.moduleSpecifier) {
+                    return (_c = symbolIsValue(node.moduleSpecifier)) !== null && _c !== void 0 ? _c : false;
+                }
+                if (ts.isInterfaceDeclaration(node)) {
+                    // If we're extending the interface of an external declaration, allow it.
+                    return symbolDefinedOutsidePackage(node.name);
+                }
+                if (ts.isModuleDeclaration(node) && !(ts.isIdentifier(node.name) && node.name.escapedText === "global")) {
+                    if (symbolDefinedOutsidePackage(node.name)) {
+                        // If we're extending a namespace in another package, allow it.
+                        return true;
+                    }
+                    // Otherwise, recurse and check for a value component.
+                }
+                return (_d = ts.forEachChild(node, containsValueDeclaration)) !== null && _d !== void 0 ? _d : false;
+            }
+            if (containsValueDeclaration(sourceFile)) {
+                hasValueDeclaration = true;
+                break;
+            }
+        }
+        if (hasNonEmptyFile && !hasValueDeclaration) {
+            context.report({
+                loc: { line: 1, column: 0 },
+                messageId: "onlyTypes",
+            });
+        }
+        return {};
+    },
+});
+module.exports = rule;
+//# sourceMappingURL=no-type-only-packages.js.map

package/dist/rules/no-type-only-packages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-type-only-packages.js","sourceRoot":"","sources":["../../src/rules/no-type-only-packages.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kCAAmE;AACnE,oDAAuD;AACvD,+CAAiC;AACjC,gDAAwB;AAExB,MAAM,IAAI,GAAG,IAAA,iBAAU,EAAC;IACtB,IAAI,EAAE,uBAAuB;IAC7B,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,4BAA4B;SAC1C;QACD,QAAQ,EAAE;YACR,SAAS,EAAE,2DAA2D;SACvE;QACD,MAAM,EAAE,EAAE;KACX;IACD,MAAM,CAAC,OAAO;QACZ,IAAI,CAAC,IAAA,iBAAU,EAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE;YACvC,OAAO,EAAE,CAAC;SACX;QAED,MAAM,GAAG,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/C,IAAI,CAAC,GAAG,EAAE;YACR,OAAO,EAAE,CAAC;SACX;QAED,MAAM,OAAO,GAAG,mBAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;QAE/D,IAAI,mBAAmB,GAAG,KAAK,CAAC;QAChC,IAAI,eAAe,GAAG,KAAK,CAAC;QAE5B,SAAS,gBAAgB,CAAC,QAAgB;YACxC,OAAO,QAAQ,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,cAAI,CAAC,QAAQ,CAAC,GAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACjG,CAAC;QAED,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,cAAc,EAAE,EAAE;YACjD,IACE,CAAC,UAAU,CAAC,iBAAiB;gBAC7B,UAAU,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC;gBAClC,gBAAgB,CAAC,UAAU,CAAC,QAAQ,CAAC,EACrC;gBACA,SAAS;aACV;YAED,eAAe,GAAG,IAAI,CAAC;YAEvB,SAAS,kBAAkB,CAAC,IAAa;gBACvC,QAAQ,IAAI,CAAC,IAAI,EAAE;oBACjB,KAAK,EAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC;oBACvC,KAAK,EAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC;oBACvC,KAAK,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC;oBACpC,KAAK,EAAE,CAAC,UAAU,CAAC,eAAe;wBAChC,OAAO,IAAI,CAAC;iBACf;gBAED,OAAO,KAAK,CAAC;YACf,CAAC;YAED,SAAS,SAAS,CAAC,IAAa;gBAC9B,MAAM,OAAO,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;gBACzC,IAAI,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;gBAC/C,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE;oBACjD,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;iBAC3C;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,SAAS,aAAa,CAAC,IAAa;gBAClC,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;gBAC/B,IAAI,MAAM,EAAE;oBACV,OAAO,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC;iBAClC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,SAAS,2BAA2B,CAAC,IAAa;;gBAChD,OAAO,CACL,MAAA,MAAA,MAAA,SAAS,CAAC,IAAI,CAAC,0CACX,eAAe,EAAE,0CACjB,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,gBAAgB,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,CAAC,mCAAI,KAAK,CAC3F,CAAC;YACJ,CAAC;YAED,SAAS,wBAAwB,CAAC,IAAa;;gBAC7C,IAAI,kBAAkB,CAAC,IAAI,CAAC,EAAE;oBAC5B,OAAO,IAAI,CAAC;iBACb;gBAED,IAAI,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,EAAE;oBACtE,OAAO,KAAK,CAAC;iBACd;gBAED,IAAI,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE;oBAC/B,OAAO,MAAA,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,mCAAI,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;iBACnF;gBAED,IAAI,EAAE,CAAC,4BAA4B,CAAC,IAAI,CAAC,EAAE;oBACzC,OAAO,MAAA,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,mCAAI,KAAK,CAAC;iBAC1C;gBAED,IAAI,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;oBAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;iBACrE;gBAED,IAAI,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,eAAe,EAAE;oBAClG,OAAO,MAAA,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,mCAAI,KAAK,CAAC;iBACrD;gBAED,IAAI,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE;oBACnC,yEAAyE;oBACzE,OAAO,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBAC/C;gBAED,IAAI,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,KAAK,QAAQ,CAAC,EAAE;oBACvG,IAAI,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;wBAC1C,+DAA+D;wBAC/D,OAAO,IAAI,CAAC;qBACb;oBACD,sDAAsD;iBACvD;gBAED,OAAO,MAAA,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,wBAAwB,CAAC,mCAAI,KAAK,CAAC;YAClE,CAAC;YAED,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE;gBACxC,mBAAmB,GAAG,IAAI,CAAC;gBAC3B,MAAM;aACP;SACF;QAED,IAAI,eAAe,IAAI,CAAC,mBAAmB,EAAE;YAC3C,OAAO,CAAC,MAAM,CAAC;gBACb,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;gBAC3B,SAAS,EAAE,WAAW;aACvB,CAAC,CAAC;SACJ;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;CACF,CAAC,CAAC;AAEH,iBAAS,IAAI,CAAC"}

package/docs/rules/no-type-only-packages.md

@@ -0,0 +1,24 @@
+# no-type-only-packages
+
+If there's no source JavaScript code at all, for example if you're writing helper types or types for a spec, you should publish the types yourself, not on Definitely Typed.
+Because they're meant to provide types for existing JavaScript code, `@types` packages are not meant to be imported directly.
+That is, you shouldn't create a Definitely Typed package that's meant to be used like `import type { ... } from "@types/foo"`.
+Nor should you expect to write `import type { ... } from "foo"` when there's no `foo` installed.
+
+**Bad**:
+
+```ts
+export interface SomeInterface {
+    someProperty: string;
+}
+```
+
+**Good**:
+
+```ts
+export interface SomeInterface {
+    someProperty: string;
+}
+
+export function someLibraryFunction(): SomeInterface;
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@definitelytyped/eslint-plugin",
-  "version": "0.0.206",
+  "version": "0.0.207",
   "description": "ESLint rules for DefinitelyTyped",
   "main": "./dist/index.js",
   "publishConfig": {