@serwist/cli 9.0.0-preview.0 → 9.0.0-preview.2

package/dist/bin.js

@@ -15,13 +15,7 @@ import inquirer from 'inquirer';
 import { glob } from 'glob';
 import ora from 'ora';
 
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/ const constants = {
+const constants = {
     defaultConfigFile: "serwist.config.js",
     ignoredDirectories: [
         "node_modules"
@@ -69,13 +63,10 @@ const logger = {
 };
 
 const require = createRequire(import.meta.url);
-// A really light wrapper on top of Node's require() to make it easier to stub
-// out reading the configuration during tests.
 function readConfig(configFile) {
     return require(configFile);
 }
 
-// The key used for the question/answer.
 const name$3 = "configLocation";
 const configLocationQuestion = {
     name: name$3,
@@ -83,31 +74,20 @@ const configLocationQuestion = {
     type: "input",
     default: constants.defaultConfigFile
 };
-/**
- * @returns The answers from inquirer.
- */ function askQuestion$5() {
+function askQuestion$5() {
     return inquirer.prompt([
         configLocationQuestion
     ]);
 }
 async function askConfigLocation() {
     const answers = await askQuestion$5();
-    // The value of the answer when the question type is 'input' is String
-    // and it has a default value, the casting is safe.
     const configLocation = answers[name$3].trim();
     assert(configLocation, errors["invalid-config-location"]);
     return configLocation;
 }
 
-// The key used for the question/answer.
 const name$2 = "globPatterns";
-/**
- * @param globDirectory The directory used for the root of globbing.
- * @returns The unique file extensions corresponding
- * to all of the files under globDirectory.
- */ async function getAllFileExtensions(globDirectory) {
-    // Use a pattern to match any file that contains a '.', since that signifies
-    // the presence of a file extension.
+async function getAllFileExtensions(globDirectory) {
     const files = await glob("**/*.*", {
         cwd: globDirectory,
         nodir: true,
@@ -120,7 +100,6 @@ const name$2 = "globPatterns";
     for (const file of files){
         const extension = upath.extname(file);
         if (extension) {
-            // Get rid of the leading . character.
             extensions.add(extension.replace(/^\./, ""));
         }
     }
@@ -128,13 +107,7 @@ const name$2 = "globPatterns";
         ...extensions
     ];
 }
-/**
- * @param globDirectory The directory used for the root of globbing.
- * @returns The answers from inquirer.
- */ async function askQuestion$4(globDirectory) {
-    // We need to get a list of extensions corresponding to files in the directory
-    // to use when asking the next question. That could potentially take some
-    // time, so we show a spinner and explanatory text.
+async function askQuestion$4(globDirectory) {
     const spinner = ora({
         text: `Examining files in ${globDirectory}...`,
         stream: process.stdout
@@ -154,12 +127,8 @@ const name$2 = "globPatterns";
 }
 async function askExtensionsToCache(globDirectory) {
     const answers = await askQuestion$4(globDirectory);
-    // The return value is an array of strings with the selected values
-    // and there is a default, the casting is safe.
     const extensions = answers[name$2];
     assert(extensions.length > 0, errors["no-file-extensions-selected"]);
-    // glob isn't happy with a single option inside of a {} group, so use a
-    // pattern without a {} group when there's only one extension.
     const extensionsPattern = extensions.length === 1 ? extensions[0] : `{${extensions.join(",")}}`;
     return [
         `**/*.${extensionsPattern}`
@@ -167,20 +136,14 @@ async function askExtensionsToCache(globDirectory) {
 }
 
 const ROOT_PROMPT = "Please enter the path to the root of your web app:";
-// The keys used for the questions/answers.
 const questionRootDirectory = "globDirectory";
 const questionManualInput = "manualDirectoryInput";
-/**
- * @returns The subdirectories of the current
- * working directory, with hidden and ignored ones filtered out.
- */ async function getSubdirectories() {
+async function getSubdirectories() {
     return await glob("*/", {
         ignore: constants.ignoredDirectories.map((directory)=>`${directory}/`)
     });
 }
-/**
- * @returns The answers from inquirer.
- */ async function askQuestion$3() {
+async function askQuestion$3() {
     const subdirectories = await getSubdirectories();
     if (subdirectories.length > 0) {
         const manualEntryChoice = "Manually enter path";
@@ -222,12 +185,9 @@ async function askRootOfWebApp() {
 }
 
 const START_URL_QUERY_PARAMS_PROMPT = "Please enter the search parameter(s) that you would like to ignore (separated by comma):";
-// The keys used for the questions/answers.
 const question_ignoreURLParametersMatching = "ignoreURLParametersMatching";
 const question_shouldAskForIgnoreURLParametersMatching = "shouldAskForIgnoreURLParametersMatching";
-/**
- * @returns The answers from inquirer.
- */ async function askQuestion$2() {
+async function askQuestion$2() {
     return inquirer.prompt([
         {
             name: question_shouldAskForIgnoreURLParametersMatching,
@@ -257,12 +217,8 @@ async function askQueryParametersInStartUrl(defaultIgnoredSearchParameters = con
     return defaultIgnoredSearchParameters.concat(ignoreSearchParameters.map((searchParam)=>new RegExp(`^${searchParam}`)));
 }
 
-// The key used for the question/answer.
 const name$1 = "swDest";
-/**
- * @param defaultDir
- * @returns The answers from inquirer.
- */ function askQuestion$1(defaultDir) {
+function askQuestion$1(defaultDir) {
     return inquirer.prompt([
         {
             name: name$1,
@@ -274,18 +230,13 @@ const name$1 = "swDest";
 }
 async function askSWDest(defaultDir = ".") {
     const answers = await askQuestion$1(defaultDir);
-    // When prompt type is input the return type is string
-    // casting is safe
     const swDest = answers[name$1].trim();
     assert(swDest, errors["invalid-sw-dest"]);
     return swDest;
 }
 
-// The key used for the question/answer.
 const name = "swSrc";
-/**
- * @returns The answers from inquirer.
- */ function askQuestion() {
+function askQuestion() {
     return inquirer.prompt([
         {
             name,
@@ -298,7 +249,6 @@ const name = "swSrc";
 }
 async function askSWSrc() {
     const answers = await askQuestion();
-    // When prompt type is input the return is string or null
     return answers[name] ? answers[name].trim() : null;
 }
 
@@ -309,7 +259,6 @@ async function askQuestions(options = {}) {
     const swSrc = isInjectManifest ? await askSWSrc() : undefined;
     const swDest = await askSWDest(globDirectory);
     const configLocation = await askConfigLocation();
-    // See https://github.com/GoogleChrome/workbox/issues/2985
     const ignoreURLParametersMatching = isInjectManifest ? undefined : await askQueryParametersInStartUrl();
     const config = {
         globDirectory,
@@ -330,7 +279,6 @@ async function askQuestions(options = {}) {
 
 async function runWizard(options = {}) {
     const { configLocation, config } = await askQuestions(options);
-    // See https://github.com/GoogleChrome/workbox/issues/2796
     const contents = `module.exports = ${stringifyObject(config)};`;
     await fse.writeFile(configLocation, contents);
     logger.log(`To build your service worker, run
@@ -343,11 +291,7 @@ as part of a build process. See https://goo.gl/fdTQBf for details.`);
     to ${configLocation}. See ${configDocsURL} for details.`);
 }
 
-/**
- * Runs the specified build command with the provided configuration.
- *
- * @param options
- */ async function runBuildCommand({ config, watch }) {
+async function runBuildCommand({ config, watch }) {
     const { count, filePaths, size, warnings } = await injectManifest(config);
     for (const warning of warnings){
         logger.warn(warning);
@@ -364,9 +308,7 @@ as part of a build process. See https://goo.gl/fdTQBf for details.`);
     }
 }
 const app = async (params)=>{
-    // This should not be a user-visible error, unless meow() messes something up.
     assert(params && Array.isArray(params.input), errors["missing-input"]);
-    // Default to showing the help message if there's no command provided.
     const [command = "help", option] = params.input;
     switch(command){
         case "wizard":
@@ -396,7 +338,6 @@ const app = async (params)=>{
                     throw logger.error(errors["invalid-config-location"]);
                 }
                 logger.log(`Using configuration from ${configPath}.`);
-                // Determine whether we're in --watch mode, or one-off mode.
                 if (params?.flags?.watch) {
                     const options = {
                         ignoreInitial: true
@@ -432,7 +373,6 @@ const app = async (params)=>{
                 }
                 break;
             }
-        // biome-ignore lint/suspicious/noFallthroughSwitchClause: Biome.js doesn't handle functions that return `never`... yet.
         case "help":
             {
                 params.showHelp();
@@ -444,16 +384,6 @@ const app = async (params)=>{
     }
 };
 
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/ // Helper to parse out less relevant info from an Error's stack trace.
-// Removes the initial portion, since that's obtained from error.message.
-// Removes every stack frame earlier than the last instance of moduleName,
-// since that's just frames related to the Node runtime/loader.
 function cleanupStackTrace(error, moduleName) {
     if (!error.stack) {
         return "";
@@ -472,13 +402,7 @@ function cleanupStackTrace(error, moduleName) {
     return frames.slice(startFrame, lastFrame + 1).join("\n");
 }
 
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/ const helpText = `Usage:
+const helpText = `Usage:
 $ serwist <command> [options]
 
 Commands:
@@ -526,7 +450,6 @@ void (async ()=>{
         await app(params);
     } catch (error) {
         if (error instanceof Error) {
-            // Show the full error and stack trace if we're run with --debug.
             if (params.flags.debug) {
                 if (error.stack) {
                     logger.error(`\n${error.stack}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/cli",
-  "version": "9.0.0-preview.0",
+  "version": "9.0.0-preview.2",
   "type": "module",
   "description": "@serwist/cli is the command line interface for Serwist.",
   "files": [
@@ -32,14 +32,14 @@
     "common-tags": "1.8.2",
     "fs-extra": "11.2.0",
     "glob": "10.3.10",
-    "inquirer": "9.2.13",
+    "inquirer": "9.2.14",
     "meow": "13.1.0",
     "ora": "8.0.1",
     "pretty-bytes": "6.1.1",
     "stringify-object": "5.0.0",
     "upath": "2.0.1",
     "update-notifier": "7.0.0",
-    "@serwist/build": "9.0.0-preview.0"
+    "@serwist/build": "9.0.0-preview.2"
   },
   "devDependencies": {
     "@types/common-tags": "1.8.4",
@@ -48,8 +48,8 @@
     "@types/stringify-object": "4.0.5",
     "@types/update-notifier": "6.0.8",
     "rollup": "4.9.6",
-    "typescript": "5.4.0-dev.20240203",
-    "@serwist/constants": "9.0.0-preview.0"
+    "typescript": "5.4.0-dev.20240206",
+    "@serwist/constants": "9.0.0-preview.2"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"