chore(script): ignore empty directories (#5591)

Author: wjhsf

scripts/shared/packages.mjs

@@ -1,22 +1,13 @@
-import { readdirSync, readFileSync } from 'node:fs';
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
+import { readFileSync } from 'node:fs';
+import { dirname } from 'node:path';
+import { globSync } from 'glob';
 
-const readJsonSync = (filepath) => JSON.parse(readFileSync(filepath, 'utf8'));
+const allPackages = globSync(['packages/lwc/package.json', 'packages/@lwc/*/package.json']);
 
-const root = join(dirname(fileURLToPath(import.meta.url)), '../..');
-const lwcPackageDir = 'packages/lwc';
-const relativeNamespaceDir = 'packages/@lwc';
-const namespacedPackageDirs = readdirSync(join(root, 'packages/@lwc'), {
-    withFileTypes: true,
-})
-    .filter((fd) => fd.isDirectory() && !fd.name.startsWith('.'))
-    .map((fd) => join(relativeNamespaceDir, fd.name));
-const allPackageDirs = [lwcPackageDir, ...namespacedPackageDirs];
-
-export const ALL_PACKAGES = allPackageDirs.map((path) => ({
-    path,
-    package: readJsonSync(join(path, 'package.json')),
+export const ALL_PACKAGES = allPackages.map((pkg) => ({
+    path: dirname(pkg),
+    package: JSON.parse(readFileSync(pkg, 'utf8')),
 }));
 export const PRIVATE_PACKAGES = ALL_PACKAGES.filter((data) => data.package.private);
 export const PUBLIC_PACKAGES = ALL_PACKAGES.filter((data) => !data.package.private);
+export const SCOPED_PACKAGES = ALL_PACKAGES.filter((data) => data.package.name.startsWith('@lwc/'));

scripts/tasks/check-and-rewrite-package-json.js

@@ -17,7 +17,7 @@
 
 const fs = require('node:fs');
 const path = require('node:path');
-const { globSync } = require('glob');
+const { SCOPED_PACKAGES } = require('../shared/packages.mjs');
 
 // This is the same list as in @lwc/rollup-plugin/src/index.ts
 const LWC_EXPOSED_MODULES = {
@@ -38,10 +38,7 @@ const STATIC_PACKAGES = ['@lwc/types'];
 
 const expectedPkgJsons = [];
 
-for (const dir of globSync('./packages/@lwc/*')) {
-    const filename = path.join('./', dir, 'package.json');
-    const actual = fs.readFileSync(filename, 'utf-8').replace(/\r\n/g, '\n'); // Windows compat
-    const pkg = JSON.parse(actual);
+for (const { package: pkg, path: dir } of SCOPED_PACKAGES) {
     // Skip private packages
     if (pkg.private) {
         continue;
@@ -131,12 +128,11 @@ for (const dir of globSync('./packages/@lwc/*')) {
         };
     }
 
-    const expected = JSON.stringify(expectedJson, null, 4) + '\n';
-
     expectedPkgJsons.push({
-        filename,
-        expected,
-        actual,
+        filename: path.join(dir, 'package.json'),
+        // Including \n because that's how prettier formats files
+        expected: JSON.stringify(expectedJson, null, 4) + '\n',
+        actual: JSON.stringify(pkg, null, 4) + '\n',
     });
 }
 

scripts/tasks/check-imports-are-declared-dependencies.js

@@ -12,17 +12,14 @@
 const path = require('node:path');
 const fs = require('node:fs');
 const { builtinModules } = require('node:module');
-const { globSync } = require('glob');
 const { init, parse } = require('es-module-lexer');
+const { SCOPED_PACKAGES } = require('../shared/packages.mjs');
 
 async function main() {
     const errors = [];
-    const pkgJsonFiles = globSync(path.join(__dirname, '../../packages/@lwc/*/package.json'));
 
-    for (const pkgJsonFile of pkgJsonFiles) {
-        const { dependencies, peerDependencies, private, module, types } = JSON.parse(
-            fs.readFileSync(pkgJsonFile, 'utf-8')
-        );
+    for (const { package: pkg, path: dir } of SCOPED_PACKAGES) {
+        const { dependencies, peerDependencies, private, module, types } = pkg;
 
         if (private) {
             continue; // not public, we don't care
@@ -33,7 +30,7 @@ async function main() {
         // We use three fields for exports: "main" for CJS, "module" for ESM, "types" for, y'know.
         // If a package has a "module" defined, we use that as the source of truth, otherwise we
         // assume it's a types-only package and we check that, instead.
-        const fileToCheck = path.join(path.dirname(pkgJsonFile), module ?? types);
+        const fileToCheck = path.join(dir, module ?? types);
 
         const esmSource = fs.readFileSync(fileToCheck, 'utf-8');
 
@@ -57,10 +54,7 @@ async function main() {
 
             if (!(importedPackage in allDependencies)) {
                 errors.push(
-                    `${pkgJsonFile
-                        .split(path.sep)
-                        .slice(-3, -1)
-                        .join(path.sep)} imports "${imported}", but it is not declared ` +
+                    `${pkg} imports "${imported}", but it is not declared ` +
                         'as a dependency/peerDependency in package.json.'
                 );
             }

scripts/tasks/generate-license-files.mjs

@@ -1,18 +1,14 @@
 import path from 'node:path';
-import { readFile, writeFile, stat, readdir } from 'node:fs/promises';
+import { readFile, writeFile, stat } from 'node:fs/promises';
 import { createRequire } from 'node:module';
 import { fileURLToPath } from 'node:url';
 import prettier from 'prettier';
 import { BUNDLED_DEPENDENCIES } from '../shared/bundled-dependencies.js';
+import { ALL_PACKAGES, SCOPED_PACKAGES } from '../shared/packages.mjs';
 
 // We're using ESM here, but some packages still only export CJS, so we also need `require`
 const require = createRequire(import.meta.url);
 
-const atLwcPackages = (await readdir('packages/@lwc'))
-    // skip dotfiles like .DS_Store
-    .filter((_) => !_.startsWith('.'))
-    .map((_) => `@lwc/${_}`);
-
 // Generate our LICENSE files for each package, including any bundled dependencies
 // This is modeled after how Rollup does it:
 // https://github.com/rollup/rollup/blob/0b665c3/build-plugins/generate-license-file.ts
@@ -43,7 +39,7 @@ function tryResolve(specifier) {
     }
     // `require.resolve` accepts a second parameter of additional places to look
     return require.resolve(specifier, {
-        paths: atLwcPackages.map((pkg) => path.join('packages', pkg, 'node_modules')),
+        paths: SCOPED_PACKAGES.map((pkg) => path.join(pkg.path, 'node_modules')),
     });
 }
 
@@ -77,7 +73,11 @@ async function findLicenseText(depName) {
         await readFile(path.join(resolvedDepPath, 'package.json'), 'utf-8')
     );
 
-    return `${license} license defined in package.json in v${version}.`;
+    if (!license) {
+        throw new Error(`${depName} does not define a license.`);
+    }
+
+    return `"${license}" license defined in package.json in v${version}.`;
 }
 
 const coreLicense = await readFile('LICENSE-CORE.md', 'utf-8');
@@ -106,11 +106,9 @@ await writeFile('LICENSE.md', formattedLicense, 'utf-8');
 
 // License file for each package as well, so that we publish it to npm
 
-const packages = ['lwc', ...atLwcPackages];
-
 await Promise.all(
-    packages.map(async (pkg) => {
-        await writeFile(path.join('packages/', pkg, 'LICENSE.md'), formattedLicense, 'utf-8');
+    ALL_PACKAGES.map(async (pkg) => {
+        await writeFile(path.join(pkg.path, 'LICENSE.md'), formattedLicense, 'utf-8');
     })
 );