lincd-cli 0.2.67 → 0.2.69

package/lib/cli-methods.js

@@ -13,13 +13,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeCommandForPackage = exports.addCapacitor = exports.addLinesToFile = exports.executeCommandForEachPackage = exports.buildUpdated = exports.publishPackage = exports.publishUpdated = exports.buildPackage = exports.register = exports.createPackage = exports.depCheck = exports.checkImports = exports.createComponent = exports.createSetComponent = exports.createShape = exports.setNameVariables = exports.createOntology = exports.getLincdPackages = exports.buildAll = exports.developPackage = exports.warn = exports.createApp = void 0;
-const path_1 = __importDefault(require("path"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const utils_1 = require("./utils");
 const chalk_1 = __importDefault(require("chalk"));
 const child_process_1 = require("child_process");
-const get_env_vars_1 = require("env-cmd/dist/get-env-vars");
 const depcheck_1 = __importDefault(require("depcheck"));
+const get_env_vars_1 = require("env-cmd/dist/get-env-vars");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const utils_1 = require("./utils");
+const fs_1 = require("fs");
 var glob = require('glob');
 var variables = {};
 var open = require('open');
@@ -723,12 +724,53 @@ const createComponent = (name, basePath = process.cwd()) => __awaiter(void 0, vo
     }
 });
 exports.createComponent = createComponent;
-const checkImports = () => __awaiter(void 0, void 0, void 0, function* () {
-    //read the source of all ts/tsx files in the src folder
-    //if there is an import that imports a lincd package with /src/ in it, then warn
-    //if there is an import that imports outside of the src folder, then warn
-    //TODO: use dependency-cruiser for this
-    //https://github.com/sverweij/dependency-cruiser/blob/HEAD/doc/api.md
+//read the source of all ts/tsx files in the src folder
+//if there is an import that imports a lincd package with /src/ in it, then warn
+//if there is an import that imports outside of the src folder, then warn
+const checkImports = (sourceFolder = getSourceFolder(), depth = 0, // Used to check if the import is outside of the src folder
+invalidImports = new Map()) => __awaiter(void 0, void 0, void 0, function* () {
+    const dir = fs_extra_1.default.readdirSync(sourceFolder);
+    // Start checking each file in the source folder
+    for (const file of dir) {
+        const filename = path_1.default.join(sourceFolder, file);
+        // File is either a directory, or not a .ts(x)
+        // INFO: For future use - if this part fails, it could be due to user permissions
+        //  i.e. the program not having access to check the file metadata
+        if (!filename.match(/\.tsx?$/)) {
+            if ((0, fs_1.statSync)(filename).isDirectory()) {
+                yield (0, exports.checkImports)(filename, depth + 1, invalidImports);
+            }
+            // Ignore all files that aren't one of the following:
+            // - .ts
+            // - .tsx
+            continue;
+        }
+        const allImports = yield (0, utils_1.getFileImports)(filename);
+        const lincdImports = allImports.filter((i) => i.includes('lincd') || i.includes('..'));
+        lincdImports.forEach((i) => {
+            if (!(0, utils_1.isValidLINCDImport)(i, depth)) {
+                if (!invalidImports.has(filename)) {
+                    invalidImports.set(filename, []);
+                }
+                invalidImports.get(filename).push(i);
+            }
+        });
+    }
+    // All recursion must have finished, display any errors
+    if (depth === 0 && invalidImports.size > 0) {
+        console.warn(chalk_1.default.red('\n' + 'Invalid imports found.  See fixes below:'));
+        console.warn(chalk_1.default.red(" - For relative imports, ensure you don't import outside of the /src/ folder"));
+        console.warn(chalk_1.default.red(' - For lincd imports, access the /lib/ folder instead of /src/'));
+        invalidImports.forEach((value, key) => {
+            console.info(chalk_1.default.red('\nFound in file ') + chalk_1.default.blue(key) + chalk_1.default.red(':'));
+            value.forEach((i) => console.warn(chalk_1.default.red("- '" + i + "'")));
+        });
+        process.exit(1);
+    }
+    else if (depth === 0 && invalidImports.size === 0) {
+        console.info('All imports OK');
+        process.exit(0);
+    }
 });
 exports.checkImports = checkImports;
 const depCheck = () => __awaiter(void 0, void 0, void 0, function* () {

package/lib/utils.js

@@ -35,14 +35,69 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLinkedTailwindColors = exports.flatten = exports.warn = exports.debugInfo = exports.debug = exports.log = exports.needsRebuilding = exports.generateScopedName = exports.execPromise = exports.execp = exports.getGruntConfig = exports.getModulePackageJSON = exports.getLastModifiedFile = exports.getLastCommitTime = exports.getLastModifiedSourceTime = exports.getLastBuildTime = exports.getLINCDDependencies = exports.getPackageJSON = void 0;
+exports.getLinkedTailwindColors = exports.flatten = exports.warn = exports.debugInfo = exports.debug = exports.log = exports.needsRebuilding = exports.generateScopedName = exports.execPromise = exports.execp = exports.getGruntConfig = exports.getModulePackageJSON = exports.getLastModifiedFile = exports.getLastCommitTime = exports.getLastModifiedSourceTime = exports.getLastBuildTime = exports.getLINCDDependencies = exports.getPackageJSON = exports.isValidLINCDImport = exports.getFileImports = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
 const child_process_1 = require("child_process");
+const typescript_1 = __importDefault(require("typescript"));
+const module_1 = require("module");
 const { findNearestPackageJson, findNearestPackageJsonSync, } = require('find-nearest-package-json');
 var glob = require('glob');
 var gruntConfig;
+// Credit: https://gist.github.com/tinovyatkin/727ddbf7e7e10831a1eca9e4ff2fc32e
+const tsHost = typescript_1.default.createCompilerHost({
+    allowJs: true,
+    noEmit: true,
+    isolatedModules: true,
+    resolveJsonModule: false,
+    moduleResolution: typescript_1.default.ModuleResolutionKind.Classic,
+    incremental: true,
+    noLib: true,
+    noResolve: true,
+}, true);
+var getFileImports = function (filePath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const sourceFile = tsHost.getSourceFile(filePath, typescript_1.default.ScriptTarget.Latest, (msg) => {
+            throw new Error(`Failed to parse ${filePath}: ${msg}`);
+        });
+        if (!sourceFile)
+            throw ReferenceError(`Failed to find file ${filePath}`);
+        const importing = [];
+        delintNode(sourceFile);
+        return importing;
+        function delintNode(node) {
+            if (typescript_1.default.isImportDeclaration(node)) {
+                const moduleName = node.moduleSpecifier.getText().replace(/['"]/g, '');
+                if (!moduleName.startsWith('node:') &&
+                    !module_1.builtinModules.includes(moduleName))
+                    importing.push(moduleName);
+            }
+            else
+                typescript_1.default.forEachChild(node, delintNode);
+        }
+    });
+};
+exports.getFileImports = getFileImports;
+/**
+ *
+ * @param importPath The import path to check
+ * @param curFileDepth How many folders deep the current file is (0 = src, 1 = src/foo, etc.)
+ * @returns
+ */
+var isValidLINCDImport = function (importPath, curFileDepth) {
+    const validLincdPath = importPath.includes('lincd') && !importPath.includes('/src/');
+    let validRelativePath = false;
+    if (importPath.includes('..')) {
+        // '../bad/path' from 'src/file.ts' should be invalid:
+        //    ^ should get split into ['', '/bad/path'], and the file depth is 0
+        //    meaning that it'll be invalid.
+        // And this should be true for all relative imports containing '..'
+        validRelativePath = importPath.split('..').length - 1 <= curFileDepth;
+    }
+    return validLincdPath || validRelativePath;
+};
+exports.isValidLINCDImport = isValidLINCDImport;
 var getPackageJSON = function (root = process.cwd(), error = true) {
     let packagePath = path.join(root, 'package.json');
     if (fs.existsSync(packagePath)) {
@@ -172,7 +227,7 @@ const getLastBuildTime = (packagePath) => {
 };
 exports.getLastBuildTime = getLastBuildTime;
 const getLastModifiedSourceTime = (packagePath) => {
-    return (0, exports.getLastModifiedFile)(packagePath + '/@(src|data|scss|modules)/**/*', {
+    return (0, exports.getLastModifiedFile)(packagePath + '/@(src|data|scss)/**/*', {
         ignore: [packagePath + '/**/*.scss.json', packagePath + '/**/*.d.ts'],
     });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lincd-cli",
-  "version": "0.2.67",
+  "version": "0.2.69",
   "description": "Command line tools for the lincd.js library",
   "main": "lib/index.js",
   "scripts": {