@stencil/cli 5.0.0-alpha.1

package/LICENSE.md

@@ -0,0 +1,27 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-present Drifty Co.
+
+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.
+
+-----------------------------------------
+Third-party components, software, and/or libraries (collectively, "components")
+are included under the licenses specified by their authors. For information
+about these third-party licenses, refer to the separate legal notices governing
+such components at NOTICE file at the top level of the package.

package/bin/stencil.mjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+// Set NODE_ENV to production by default (matches legacy webpack bundling behavior)
+// This suppresses development-only warnings from dependencies like PostCSS
+process.env.NODE_ENV ??= 'production';
+
+import { run } from '@stencil/cli';
+import { createNodeLogger, createNodeSys } from '@stencil/core/sys/node';
+
+run({
+  args: process.argv.slice(2),
+  logger: createNodeLogger(),
+  sys: createNodeSys(),
+});

package/dist/index.d.mts

@@ -0,0 +1,153 @@
+import * as _$_stencil_core_compiler0 from "@stencil/core/compiler";
+import { LogLevel } from "@stencil/core/compiler";
+
+//#region src/types.d.ts
+/**
+ * Supported CLI task commands
+ */
+type TaskCommand = 'build' | 'docs' | 'generate' | 'g' | 'help' | 'info' | 'prerender' | 'serve' | 'telemetry' | 'test' | 'version';
+//#endregion
+//#region src/config-flags.d.ts
+/**
+ * All the Boolean options supported by the Stencil CLI
+ */
+declare const BOOLEAN_CLI_FLAGS: readonly ["build", "cache", "checkVersion", "ci", "compare", "debug", "dev", "devtools", "docs", "e2e", "es5", "esm", "help", "log", "open", "prerender", "prerenderExternal", "prod", "profile", "serviceWorker", "screenshot", "serve", "skipNodeCheck", "spec", "ssr", "updateScreenshot", "verbose", "version", "watch", "all", "automock", "bail", "changedFilesWithAncestor", "clearCache", "clearMocks", "collectCoverage", "color", "colors", "coverage", "detectLeaks", "detectOpenHandles", "errorOnDeprecated", "expand", "findRelatedTests", "forceExit", "init", "injectGlobals", "json", "lastCommit", "listTests", "logHeapUsage", "noStackTrace", "notify", "onlyChanged", "onlyFailures", "passWithNoTests", "resetMocks", "resetModules", "restoreMocks", "runInBand", "runTestsByPath", "showConfig", "silent", "skipFilter", "testLocationInResults", "updateSnapshot", "useStderr", "watchAll", "watchman"];
+/**
+ * All the Number options supported by the Stencil CLI
+ */
+declare const NUMBER_CLI_FLAGS: readonly ["port", "maxConcurrency", "testTimeout"];
+/**
+ * All the String options supported by the Stencil CLI
+ */
+declare const STRING_CLI_FLAGS: readonly ["address", "config", "docsApi", "docsJson", "emulate", "root", "screenshotConnector", "cacheDirectory", "changedSince", "collectCoverageFrom", "coverageDirectory", "coverageThreshold", "env", "filter", "globalSetup", "globalTeardown", "globals", "haste", "moduleNameMapper", "notifyMode", "outputFile", "preset", "prettierPath", "resolver", "rootDir", "runner", "testEnvironment", "testEnvironmentOptions", "testFailureExitCode", "testNamePattern", "testResultsProcessor", "testRunner", "testSequencer", "testURL", "timers", "transform"];
+declare const STRING_ARRAY_CLI_FLAGS: readonly ["collectCoverageOnlyFrom", "coveragePathIgnorePatterns", "coverageReporters", "moduleDirectories", "moduleFileExtensions", "modulePathIgnorePatterns", "modulePaths", "projects", "reporters", "roots", "selectProjects", "setupFiles", "setupFilesAfterEnv", "snapshotSerializers", "testMatch", "testPathIgnorePatterns", "testPathPattern", "testRegex", "transformIgnorePatterns", "unmockedModulePathPatterns", "watchPathIgnorePatterns"];
+/**
+ * All the CLI arguments which may have string or number values
+ *
+ * `maxWorkers` is an argument which is used both by Stencil _and_ by Jest,
+ * which means that we need to support parsing both string and number values.
+ */
+declare const STRING_NUMBER_CLI_FLAGS: readonly ["maxWorkers"];
+/**
+ * All the CLI arguments which may have boolean or string values.
+ */
+declare const BOOLEAN_STRING_CLI_FLAGS: readonly ["headless", "stats"];
+/**
+ * All the LogLevel-type options supported by the Stencil CLI
+ *
+ * This is a bit silly since there's only one such argument atm,
+ * but this approach lets us make sure that we're handling all
+ * our arguments in a type-safe way.
+ */
+declare const LOG_LEVEL_CLI_FLAGS: readonly ["logLevel"];
+/**
+ * Given two types `K` and `T` where `K` extends `ReadonlyArray<string>`,
+ * construct a type which maps the strings in `K` as keys to values of type `T`.
+ *
+ * Because we use types derived this way to construct an interface (`ConfigFlags`)
+ * for which we want optional keys, we make all the properties optional (w/ `'?'`)
+ * and possibly null.
+ */
+type ObjectFromKeys<K extends ReadonlyArray<string>, T> = { [key in K[number]]?: T | null };
+/**
+ * Type containing the possible Boolean configuration flags, to be included
+ * in ConfigFlags, below
+ */
+type BooleanConfigFlags = ObjectFromKeys<typeof BOOLEAN_CLI_FLAGS, boolean>;
+/**
+ * Type containing the possible String configuration flags, to be included
+ * in ConfigFlags, below
+ */
+type StringConfigFlags = ObjectFromKeys<typeof STRING_CLI_FLAGS, string>;
+/**
+ * Type containing the possible String Array configuration flags. This is
+ * one of the 'constituent types' for `ConfigFlags`.
+ */
+type StringArrayConfigFlags = ObjectFromKeys<typeof STRING_ARRAY_CLI_FLAGS, string[]>;
+/**
+ * Type containing the possible numeric configuration flags, to be included
+ * in ConfigFlags, below
+ */
+type NumberConfigFlags = ObjectFromKeys<typeof NUMBER_CLI_FLAGS, number>;
+/**
+ * Type containing the configuration flags which may be set to either string
+ * or number values.
+ */
+type StringNumberConfigFlags = ObjectFromKeys<typeof STRING_NUMBER_CLI_FLAGS, string | number>;
+/**
+ * Type containing the configuration flags which may be set to either string
+ * or boolean values.
+ */
+type BooleanStringConfigFlags = ObjectFromKeys<typeof BOOLEAN_STRING_CLI_FLAGS, boolean | string>;
+/**
+ * Type containing the possible LogLevel configuration flags, to be included
+ * in ConfigFlags, below
+ */
+type LogLevelFlags = ObjectFromKeys<typeof LOG_LEVEL_CLI_FLAGS, LogLevel>;
+/**
+ * The configuration flags which can be set by the user on the command line.
+ * This interface captures both known arguments (which are enumerated and then
+ * parsed according to their types) and unknown arguments which the user may
+ * pass at the CLI.
+ *
+ * Note that this interface is constructed by extending `BooleanConfigFlags`,
+ * `StringConfigFlags`, etc. These types are in turn constructed from types
+ * extending `ReadonlyArray<string>` which we declare in another module. This
+ * allows us to record our known CLI arguments in one place, using a
+ * `ReadonlyArray<string>` to get both a type-level representation of what CLI
+ * options we support and a runtime list of strings which can be used to match
+ * on actual flags passed by the user.
+ */
+interface ConfigFlags extends BooleanConfigFlags, StringConfigFlags, StringArrayConfigFlags, NumberConfigFlags, StringNumberConfigFlags, BooleanStringConfigFlags, LogLevelFlags {
+  task: TaskCommand | null;
+  args: string[];
+  knownArgs: string[];
+  unknownArgs: string[];
+}
+/**
+ * Helper function for initializing a `ConfigFlags` object. Provide any overrides
+ * for default values and off you go!
+ *
+ * @param init an object with any overrides for default values
+ * @returns a complete CLI flag object
+ */
+declare const createConfigFlags: (init?: Partial<ConfigFlags>) => ConfigFlags;
+//#endregion
+//#region src/parse-flags.d.ts
+/**
+ * Parse command line arguments into a structured `ConfigFlags` object
+ *
+ * @param args an array of CLI flags
+ * @returns a structured ConfigFlags object
+ */
+declare const parseFlags: (args: string[]) => ConfigFlags;
+//#endregion
+//#region src/load-compiler.d.ts
+type CoreCompiler = typeof _$_stencil_core_compiler0;
+//#endregion
+//#region src/run.d.ts
+/**
+ * Main entry point for the Stencil CLI
+ *
+ * Take care of parsing CLI arguments, initializing various components needed
+ * by the rest of the program, and kicking off the correct task (build, test,
+ * etc).
+ *
+ * @param init initial CLI options
+ * @returns an empty promise
+ */
+declare const run: (init: _$_stencil_core_compiler0.CliInitOptions) => Promise<any>;
+/**
+ * Run a specified task
+ *
+ * @param coreCompiler an instance of a minimal, bootstrap compiler for running the specified task
+ * @param config a configuration for the Stencil project to apply to the task run
+ * @param task the task to run
+ * @param sys the {@link d.CompilerSystem} for interacting with the operating system
+ * @param flags the parsed CLI flags (owned by CLI, not passed to Core)
+ * @public
+ * @returns a void promise
+ */
+declare const runTask: (coreCompiler: CoreCompiler, config: _$_stencil_core_compiler0.Config, task: TaskCommand, sys: _$_stencil_core_compiler0.CompilerSystem, flags?: ConfigFlags) => Promise<void>;
+//#endregion
+export { BOOLEAN_CLI_FLAGS, type ConfigFlags, type TaskCommand, createConfigFlags, parseFlags, run, runTask };