@mui/internal-code-infra 0.0.3-canary.22 → 0.0.3-canary.24

package/README.md

@@ -1,3 +1,50 @@
 # @mui/internal-code-infra
 
 Scripts and configs to be used across MUI repos.
+
+## Publishing packages
+
+1. Go to the publish action -
+
+- [Base UI](https://github.com/mui/base-ui/actions/workflows/publish.yml)
+- [Core](https://github.com/mui/material-ui/actions/workflows/publish.yml)
+- [MUI X](https://github.com/mui/mui-x/actions/workflows/publish.yml)
+
+2. Choose "Run workflow" dropdown
+
+   > - **Branch:** master
+   > - **Commit SHA to release from:** the commit that contains the merged release on master. This commit is linked to the GitHub release.
+   > - **Run in dry-run mode:** Used for debugging.
+   > - **Create GitHub release:** Keep selected if you want a GitHub release to be automatically created from the changelog.
+   > - **npm dist tag to publish to** Use to publish legacy or canary versions.
+
+3. Click "Run workflow"
+4. Refresh the page to see the newly created workflow, and click it.
+5. The next screen shows "@username requested your review to deploy to npm-publish", click "Review deployments" and authorize your workflow run. **Never approve workflow runs you didn't initiaite.**
+
+> [!IMPORTANT]  
+> Go through the below steps if there is an error that says `The following packages are new and need to be published manually first` in the publish flow.
+
+### Adding and publishing new packages
+
+Whenever news packages are added to the repo (that will get published to npm) or a private package is turned into a public one, follow the below steps before invoking the publish workflow of the previous section.
+
+1. Goto your repo's code base on your system, open terminal and run:
+
+```bash
+pnpm code-infra publish-new-package
+```
+
+This command detects the new public packages in the repo and asks for your confirmation before publishing them to the npm registry. Add the `--dryRun` flag to skip the actual publishing.
+
+2. Goto the settings link for each packages, ie, https://www.npmjs.com/package/<pkg-name>/access , and setup `Trusted Publisher`.
+3. In `Select your publisher` step in the above link, click on the `Github Actions` button to configure Github actions based trusted publishing.
+4. Fill in the details of the repo -
+   1. `Organization or user` as `mui`,
+   2. `Repository` as per the new package
+   3. `Workflow filename*` should be `publish.yml`
+   4. `Environment name` should be `npm-publish`
+5. In the `Publishing access` section, toggle the recommended option of `Require two-factor authentication and disallow tokens`.
+6. Finally, save the changes by clicking on `Update Package Settings` button.
+
+After following these steps, the `Publish` workflow can be invoked again.

package/build/babel-config.d.mts

@@ -0,0 +1,36 @@
+/**
+ * @param {Object} param0
+ * @param {boolean} [param0.debug]
+ * @param {boolean} [param0.optimizeClsx]
+ * @param {boolean} [param0.removePropTypes]
+ * @param {boolean} [param0.noResolveImports]
+ * @param {'cjs' | 'esm'} param0.bundle
+ * @param {string | null} param0.outExtension - Specify the output file extension.
+ * @param {string} param0.runtimeVersion
+ * @returns {import('@babel/core').TransformOptions} The base Babel configuration.
+ */
+export function getBaseConfig({ debug, optimizeClsx, removePropTypes, noResolveImports, bundle, runtimeVersion, outExtension, }: {
+    debug?: boolean | undefined;
+    optimizeClsx?: boolean | undefined;
+    removePropTypes?: boolean | undefined;
+    noResolveImports?: boolean | undefined;
+    bundle: "cjs" | "esm";
+    outExtension: string | null;
+    runtimeVersion: string;
+}): import("@babel/core").TransformOptions;
+/**
+ * @typedef {Object} Options
+ * @prop {'esm' | 'cjs'} [Options.bundle]
+ * @prop {boolean} [Options.noResolveImports]
+ * @prop {undefined} [options.env]
+ */
+/**
+ * @param {import('@babel/core').ConfigAPI | Options} api
+ * @returns {import('@babel/core').TransformOptions}
+ */
+export default function getBabelConfig(api: import("@babel/core").ConfigAPI | Options): import("@babel/core").TransformOptions;
+export type Options = {
+    bundle?: "cjs" | "esm" | undefined;
+    noResolveImports?: boolean | undefined;
+    env?: undefined;
+};

package/build/cli/cmdArgosPush.d.mts

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+declare const _default: import("yargs").CommandModule<{}, Args>;
+export default _default;
+export type Args = {
+    /**
+     * - Run with verbose logging
+     */
+    verbose?: boolean | undefined;
+    /**
+     * - Screenshots folder path
+     */
+    folder: string;
+};

package/build/cli/cmdBuild.d.mts

@@ -0,0 +1,52 @@
+declare const _default: import("yargs").CommandModule<{}, Args>;
+export default _default;
+export type Args = {
+    /**
+     * - The bundles to build.
+     */
+    bundle: import("../utils/build.mjs").BundleType[];
+    /**
+     * - The large files to build.
+     */
+    hasLargeFiles: boolean;
+    /**
+     * - Whether to skip generating a package.json file in the /esm folder.
+     */
+    skipBundlePackageJson: boolean;
+    /**
+     * - The directory to copy the cjs files to.
+     */
+    cjsOutDir: string;
+    /**
+     * - Whether to enable verbose logging.
+     */
+    verbose: boolean;
+    /**
+     * - Whether to build types for the package.
+     */
+    buildTypes: boolean;
+    /**
+     * - Whether to build types for the package.
+     */
+    skipTsc: boolean;
+    /**
+     * - Whether to skip checking for Babel runtime dependencies in the package.
+     */
+    skipBabelRuntimeCheck: boolean;
+    /**
+     * - Whether to skip generating the package.json file in the bundle output.
+     */
+    skipPackageJson: boolean;
+    /**
+     * - Whether to skip checking for main field in package.json.
+     */
+    skipMainCheck: boolean;
+    /**
+     * - Globs to be ignored by Babel.
+     */
+    ignore: string[];
+    /**
+     * - Files/Directories to be copied. Can be a glob pattern.
+     */
+    copy?: string[] | undefined;
+};

package/build/cli/cmdCopyFiles.d.mts

@@ -0,0 +1,20 @@
+declare const _default: import("yargs").CommandModule<{}, Args>;
+export default _default;
+export type Args = {
+    /**
+     * Run in silent mode without logging
+     */
+    silent?: boolean | undefined;
+    /**
+     * Exclude default files from the copy operation
+     */
+    excludeDefaults?: boolean | undefined;
+    /**
+     * Glob patterns to copy
+     */
+    glob?: string[] | undefined;
+    /**
+     * Extra files to copy
+     */
+    files?: string[] | undefined;
+};

package/build/cli/cmdExtractErrorCodes.d.mts

@@ -0,0 +1,3 @@
+declare const _default: import("yargs").CommandModule<{}, Args>;
+export default _default;
+export type Args = import("../utils/extractErrorCodes.mjs").Args;

package/build/cli/cmdGithubAuth.d.mts

@@ -0,0 +1,6 @@
+declare const _default: import("yargs").CommandModule<{}, Args>;
+export default _default;
+export type Args = {
+    authorize: boolean;
+    clear: boolean;
+};

package/build/cli/cmdJsonLint.d.mts

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+declare const _default: import("yargs").CommandModule<{}, Args>;
+export default _default;
+export type Args = {
+    /**
+     * Run in silent mode without logging
+     */
+    silent?: boolean | undefined;
+};

package/build/cli/cmdListWorkspaces.d.mts

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+declare const _default: import("yargs").CommandModule<{}, Args>;
+export default _default;
+export type PublicPackage = import("../utils/pnpm.mjs").PublicPackage;
+export type Args = {
+    /**
+     * - Whether to filter to only public packages
+     */
+    publicOnly?: boolean | undefined;
+    /**
+     * - Output format (name, path, or json)
+     */
+    output?: "name" | "json" | "path" | "publish-dir" | undefined;
+    /**
+     * - Git reference to filter changes since
+     */
+    sinceRef?: string | undefined;
+};

package/build/cli/cmdPublish.d.mts

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+declare const _default: import("yargs").CommandModule<{}, Args>;
+export default _default;
+export type Args = {
+    /**
+     * Run in dry-run mode without publishing
+     */
+    "dry-run": boolean;
+    /**
+     * Create a GitHub draft release after publishing
+     */
+    "github-release": boolean;
+    /**
+     * NPM dist tag to publish to
+     */
+    tag: string;
+};
+export type PublicPackage = import("../utils/pnpm.mjs").PublicPackage;
+export type PublishOptions = import("../utils/pnpm.mjs").PublishOptions;

package/build/cli/cmdPublishCanary.d.mts

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+declare const _default: import("yargs").CommandModule<{}, Args>;
+export default _default;
+export type PublicPackage = import("../utils/pnpm.mjs").PublicPackage;
+export type VersionInfo = import("../utils/pnpm.mjs").VersionInfo;
+export type PublishOptions = import("../utils/pnpm.mjs").PublishOptions;
+export type Args = {
+    /**
+     * - Whether to run in dry-run mode
+     */
+    dryRun?: boolean | undefined;
+};

package/build/cli/cmdPublishNewPackage.d.mts

@@ -0,0 +1,8 @@
+declare const _default: import("yargs").CommandModule<{}, Args>;
+export default _default;
+export type Args = {
+    /**
+     * If true, will only log the commands without executing them
+     */
+    dryRun?: boolean | undefined;
+};

package/build/cli/cmdSetVersionOverrides.d.mts

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+declare const _default: import("yargs").CommandModule<{}, Args>;
+export default _default;
+export type Args = {
+    /**
+     * - Package version specifiers in format 'package@version'
+     */
+    pkg?: string[] | undefined;
+};

package/build/cli/index.d.mts

@@ -0,0 +1 @@
+export {};

package/build/eslint/baseConfig.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @param {Object} [params]
+ * @param {boolean} [params.enableReactCompiler] - Whether the config is for spec files.
+ * @param {string} params.baseDirectory - The base directory for the configuration.
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export function createBaseConfig({ enableReactCompiler, baseDirectory }?: {
+    enableReactCompiler?: boolean | undefined;
+    baseDirectory: string;
+}): import("eslint").Linter.Config[];

package/build/eslint/docsConfig.d.mts

@@ -0,0 +1,4 @@
+/**
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export function createDocsConfig(): import("eslint").Linter.Config[];

package/build/eslint/extensions.d.mts

@@ -0,0 +1,8 @@
+export const EXTENSION_JS: "?(c|m)js?(x)";
+export const EXTENSION_JS_NO_MODULE: "js?(x)";
+export const EXTENSION_TS: "?(c|m)[jt]s?(x)";
+export const EXTENSION_TS_NO_MODULE: "[jt]s?(x)";
+export const EXTENSION_TS_ONLY: "?(c|m)ts?(x)";
+export const EXTENSION_TS_ONLY_NO_MODULE: "ts?(x)";
+export const EXTENSION_DTS: ".d.?(c|m)ts?(x)";
+export const EXTENSION_TEST_FILE: ".test.?(c|m)[jt]s?(x)";

package/build/eslint/index.d.mts

@@ -0,0 +1,4 @@
+export * from "./baseConfig.mjs";
+export * from "./docsConfig.mjs";
+export * from "./testConfig.mjs";
+export * from "./extensions.mjs";

package/build/eslint/material-ui/config.d.mts

@@ -0,0 +1,7 @@
+/**
+ * @param {Object} [options]
+ * @param {boolean} [options.reactCompilerEnabled] - Whether the config is for spec files.
+ */
+export function createCoreConfig(options?: {
+    reactCompilerEnabled?: boolean | undefined;
+}): import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];

package/build/eslint/material-ui/index.d.mts

@@ -0,0 +1,2 @@
+declare const _default: import("eslint").ESLint.Plugin;
+export default _default;

package/build/eslint/material-ui/rules/disallow-active-element-as-key-event-target.d.mts

@@ -0,0 +1,5 @@
+export default rule;
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+declare const rule: import("eslint").Rule.RuleModule;

package/build/eslint/material-ui/rules/disallow-react-api-in-server-components.d.mts

@@ -0,0 +1,2 @@
+declare const _default: import("eslint").Rule.RuleModule;
+export default _default;

package/build/eslint/material-ui/rules/docgen-ignore-before-comment.d.mts

@@ -0,0 +1,2 @@
+declare const _default: import("eslint").Rule.RuleModule;
+export default _default;

package/build/eslint/material-ui/rules/mui-name-matches-component-name.d.mts

@@ -0,0 +1,5 @@
+export default rule;
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+declare const rule: import("eslint").Rule.RuleModule;

package/build/eslint/material-ui/rules/no-empty-box.d.mts

@@ -0,0 +1,5 @@
+export default rule;
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+declare const rule: import("eslint").Rule.RuleModule;

package/build/eslint/material-ui/rules/no-restricted-resolved-imports.d.mts

@@ -0,0 +1,12 @@
+declare const _default: import("eslint").Rule.RuleModule;
+export default _default;
+export type PatternConfig = {
+    /**
+     * - The pattern to match against resolved imports
+     */
+    pattern: string;
+    /**
+     * - Custom message to show when the pattern matches
+     */
+    message?: string | undefined;
+};

package/build/eslint/material-ui/rules/no-styled-box.d.mts

@@ -0,0 +1,5 @@
+export default rule;
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+declare const rule: import("eslint").Rule.RuleModule;

package/build/eslint/material-ui/rules/rules-of-use-theme-variants.d.mts

@@ -0,0 +1,9 @@
+declare const _default: {
+    meta: {
+        type: "problem";
+    };
+    create(context: import("eslint").Rule.RuleContext): {
+        CallExpression(node: import("estree").CallExpression & import("eslint").Rule.NodeParentExtension): void;
+    };
+};
+export default _default;

package/build/eslint/material-ui/rules/straight-quotes.d.mts

@@ -0,0 +1,5 @@
+export default rule;
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+declare const rule: import("eslint").Rule.RuleModule;

package/build/eslint/testConfig.d.mts

@@ -0,0 +1,12 @@
+/**
+ * @param {Object} [options]
+ * @param {boolean} [options.useMocha]
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export function createTestConfig(options?: {
+    useMocha?: boolean | undefined;
+}): import("eslint").Linter.Config[];
+/**
+ * @type {import('eslint').Linter.Config}
+ */
+export const baseSpecRules: import("eslint").Linter.Config;

package/build/markdownlint/duplicate-h1.d.mts

@@ -0,0 +1,27 @@
+declare namespace _default {
+    export let names: string[];
+    export let description: string;
+    export let tags: string[];
+    export function _function(params: import("./duplicate-h1.mjs").MdParams, onError: import("./duplicate-h1.mjs").OnError): void;
+    export { _function as function };
+}
+export default _default;
+export type Attr = [string, string];
+export type Token = {
+    type: string;
+    info: string;
+    tag: string;
+    content: string;
+    lineNumber: number;
+    attrs: Attr[];
+};
+export type OnErrorObj = {
+    lineNumber: number;
+    detail?: string | undefined;
+};
+export type OnError = (err: OnErrorObj) => void;
+export type MdParams = {
+    name: string;
+    lines: string[];
+    tokens: Token[];
+};

package/build/markdownlint/git-diff.d.mts

@@ -0,0 +1,8 @@
+declare namespace _default {
+    export let names: string[];
+    export let description: string;
+    export let tags: string[];
+    export function _function(params: import("./duplicate-h1.mjs").MdParams, onError: import("./duplicate-h1.mjs").OnError): void;
+    export { _function as function };
+}
+export default _default;

package/build/markdownlint/index.d.mts

@@ -0,0 +1,56 @@
+/**
+ * Create a base configuration for markdownlint.
+ * @param {Object} options
+ * @param {(typeof straightQuotes)[]} [options.rules] - An array of custom rules to include.
+ * @param {string[]} [options.ignores] - An array of glob patterns to ignore.
+ * @returns
+ */
+export function createBaseConfig(options?: {
+    rules?: {
+        names: string[];
+        description: string;
+        tags: string[];
+        function: (params: import("./duplicate-h1.mjs").MdParams, onError: import("./duplicate-h1.mjs").OnError) => void;
+    }[] | undefined;
+    ignores?: string[] | undefined;
+}): {
+    config: {
+        default: boolean;
+        MD004: boolean;
+        MD009: {
+            br_spaces: number;
+            strict: boolean;
+            list_item_empty_lines: boolean;
+        };
+        MD013: boolean;
+        MD014: boolean;
+        MD024: {
+            siblings_only: boolean;
+        };
+        MD025: {
+            level: number;
+            front_matter_title: string;
+        };
+        MD033: boolean;
+        MD034: boolean;
+        MD028: boolean;
+        MD029: boolean;
+        MD031: boolean;
+        MD036: boolean;
+        MD051: boolean;
+        MD052: boolean;
+        MD059: boolean;
+        straightQuotes: boolean;
+        gitDiff: boolean;
+        tableAlignment: boolean;
+        terminalLanguage: boolean;
+        duplicateH1: boolean;
+    };
+    customRules: {
+        names: string[];
+        description: string;
+        tags: string[];
+        function: (params: import("./duplicate-h1.mjs").MdParams, onError: import("./duplicate-h1.mjs").OnError) => void;
+    }[];
+    ignores: string[];
+};

package/build/markdownlint/straight-quotes.d.mts

@@ -0,0 +1,8 @@
+declare namespace _default {
+    export let names: string[];
+    export let description: string;
+    export let tags: string[];
+    export function _function(params: import("./duplicate-h1.mjs").MdParams, onError: import("./duplicate-h1.mjs").OnError): void;
+    export { _function as function };
+}
+export default _default;

package/build/markdownlint/table-alignment.d.mts

@@ -0,0 +1,8 @@
+declare namespace _default {
+    export let names: string[];
+    export let description: string;
+    export let tags: string[];
+    export function _function(params: import("./duplicate-h1.mjs").MdParams, onError: import("./duplicate-h1.mjs").OnError): void;
+    export { _function as function };
+}
+export default _default;

package/build/markdownlint/terminal-language.d.mts

@@ -0,0 +1,8 @@
+declare namespace _default {
+    export let names: string[];
+    export let description: string;
+    export let tags: string[];
+    export function _function(params: import("./duplicate-h1.mjs").MdParams, onError: import("./duplicate-h1.mjs").OnError): void;
+    export { _function as function };
+}
+export default _default;

package/build/prettier.d.mts

@@ -0,0 +1,20 @@
+/**
+ * @param {Object} [options={}]
+ * @param {Override[]} [options.overrides]
+ * @returns {import('prettier').Config}
+ */
+export function createBaseConfig(options?: {
+    overrides?: {
+        files: string | string[];
+        excludeFiles?: string | string[];
+        options?: import("prettier").Options;
+    }[] | undefined;
+}): import("prettier").Config;
+/**
+ * @typedef {Exclude<import('prettier').Config['overrides'], undefined>[number]} Override
+ */
+/**
+ * @type {Override[]}
+ */
+export const docsOverrides: Override[];
+export type Override = Exclude<import("prettier").Config["overrides"], undefined>[number];

package/build/stylelint/index.d.mts

@@ -0,0 +1,32 @@
+declare const _default: {
+    extends: (string | string[]) | undefined;
+    rules: {
+        'no-descending-specificity': null;
+        'alpha-value-notation': null;
+        'custom-property-pattern': null;
+        'media-feature-range-notation': null;
+        'no-empty-source': null;
+        'selector-class-pattern': null;
+        'string-no-newline': null;
+        'value-keyword-case': null;
+        'import-notation': null;
+        'at-rule-empty-line-before': null;
+        'comment-empty-line-before': null;
+        'custom-property-empty-line-before': null;
+        'declaration-empty-line-before': null;
+        'rule-empty-line-before': null;
+        'at-rule-no-unknown': (boolean | {
+            ignoreAtRules: string[];
+        })[];
+        'property-no-vendor-prefix': null;
+        'property-no-deprecated': null;
+        'declaration-property-value-keyword-no-deprecated': null;
+        'color-hex-length': null;
+        'declaration-block-no-redundant-longhand-properties': null;
+    };
+    overrides: {
+        files: string[];
+        customSyntax: any;
+    }[];
+};
+export default _default;

package/build/utils/babel.d.mts

@@ -0,0 +1,66 @@
+/**
+ * @param {string} pkgVersion
+ * @returns {Record<string, string>} An object containing version-related environment variables.
+ */
+export function getVersionEnvVariables(pkgVersion: string): Record<string, string>;
+/**
+ * Copies CommonJS files from one directory to another.
+ * @param {Object} param0
+ * @param {string} param0.from - The source directory.
+ * @param {string} param0.to - The destination directory.
+ * @returns {Promise<void>}
+ */
+export function cjsCopy({ from, to }: {
+    from: string;
+    to: string;
+}): Promise<void>;
+/**
+ * @typedef {Object} ErrorCodeMetadata
+ * @property {string} outputPath - The path where the error code file should be written.
+ * @property {'annotate' | 'throw' | 'write'} [missingError] - How to handle missing error codes.
+ * @property {string} [runtimeModule] - The runtime module to replace the errors with.
+ */
+/**
+ * @param {Object} options
+ * @param {boolean} [options.verbose=false] - Whether to enable verbose logging.
+ * @param {boolean} [options.optimizeClsx=false] - Whether to enable clsx call optimization transform.
+ * @param {boolean} [options.removePropTypes=true] - Whether to enable removal of React prop types.
+ * @param {string[]} [options.ignores] - The globs to be ignored by Babel.
+ * @param {string} options.cwd - The package root directory.
+ * @param {string} options.pkgVersion - The package version.
+ * @param {string} options.sourceDir - The source directory to build from.
+ * @param {string} options.outDir - The output directory for the build.
+ * @param {string} options.outExtension - The output file extension for the build.
+ * @param {boolean} options.hasLargeFiles - Whether the build includes large files.
+ * @param {import('./build.mjs').BundleType} options.bundle - The bundles to build.
+ * @param {string} options.babelRuntimeVersion - The version of @babel/runtime to use.
+ * @returns {Promise<void>}
+ */
+export function babelBuild({ cwd, sourceDir, outDir, babelRuntimeVersion, hasLargeFiles, bundle, pkgVersion, outExtension, optimizeClsx, removePropTypes, verbose, ignores, }: {
+    verbose?: boolean | undefined;
+    optimizeClsx?: boolean | undefined;
+    removePropTypes?: boolean | undefined;
+    ignores?: string[] | undefined;
+    cwd: string;
+    pkgVersion: string;
+    sourceDir: string;
+    outDir: string;
+    outExtension: string;
+    hasLargeFiles: boolean;
+    bundle: import("./build.mjs").BundleType;
+    babelRuntimeVersion: string;
+}): Promise<void>;
+export type ErrorCodeMetadata = {
+    /**
+     * - The path where the error code file should be written.
+     */
+    outputPath: string;
+    /**
+     * - How to handle missing error codes.
+     */
+    missingError?: "throw" | "annotate" | "write" | undefined;
+    /**
+     * - The runtime module to replace the errors with.
+     */
+    runtimeModule?: string | undefined;
+};