@vidavidorra/create-project 1.0.0

package/dist/content/package.d.ts

@@ -0,0 +1,211 @@
+import { z } from 'zod';
+import { type Options } from '../options.js';
+import { File } from './file.js';
+declare const schema: z.ZodObject<{
+    name: z.ZodString;
+    version: z.ZodString;
+    description: z.ZodString;
+    private: z.ZodOptional<z.ZodBoolean>;
+    homepage: z.ZodString;
+    bugs: z.ZodObject<{
+        url: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        url: string;
+    }, {
+        url: string;
+    }>;
+    repository: z.ZodObject<{
+        type: z.ZodLiteral<"git">;
+        url: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        type: "git";
+        url: string;
+    }, {
+        type: "git";
+        url: string;
+    }>;
+    license: z.ZodLiteral<"GPL-3.0-or-later">;
+    author: z.ZodString;
+    type: z.ZodLiteral<"module">;
+    exports: z.ZodOptional<z.ZodString>;
+    files: z.ZodOptional<z.ZodTuple<[z.ZodLiteral<"./dist/**/!(*.test).{js,d.ts,cjs}">], z.ZodString>>;
+    scripts: z.ZodObject<{
+        build: z.ZodString;
+        format: z.ZodString;
+        'format:check': z.ZodString;
+        lint: z.ZodLiteral<"npm run format:check && xo">;
+        'lint:fix': z.ZodLiteral<"npm run format && xo --fix">;
+        prepare: z.ZodLiteral<"husky install .github/husky">;
+        test: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        format: string;
+        lint: "npm run format:check && xo";
+        build: string;
+        test: string;
+        'format:check': string;
+        'lint:fix': "npm run format && xo --fix";
+        prepare: "husky install .github/husky";
+    }, {
+        format: string;
+        lint: "npm run format:check && xo";
+        build: string;
+        test: string;
+        'format:check': string;
+        'lint:fix': "npm run format && xo --fix";
+        prepare: "husky install .github/husky";
+    }>;
+    commitlint: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    xo: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    prettier: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    release: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    ava: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    c8: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    dependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    devDependencies: z.ZodRecord<z.ZodString, z.ZodString>;
+    engines: z.ZodObject<{
+        node: z.ZodLiteral<">=18">;
+    }, "strict", z.ZodTypeAny, {
+        node: ">=18";
+    }, {
+        node: ">=18";
+    }>;
+    publishConfig: z.ZodObject<{
+        access: z.ZodLiteral<"public">;
+    }, "strict", z.ZodTypeAny, {
+        access: "public";
+    }, {
+        access: "public";
+    }>;
+}, "strict", z.ZodTypeAny, {
+    type: "module";
+    description: string;
+    author: string;
+    name: string;
+    release: Record<string, unknown>;
+    version: string;
+    homepage: string;
+    bugs: {
+        url: string;
+    };
+    repository: {
+        type: "git";
+        url: string;
+    };
+    license: "GPL-3.0-or-later";
+    prettier: Record<string, unknown>;
+    scripts: {
+        format: string;
+        lint: "npm run format:check && xo";
+        build: string;
+        test: string;
+        'format:check': string;
+        'lint:fix': "npm run format && xo --fix";
+        prepare: "husky install .github/husky";
+    };
+    commitlint: Record<string, unknown>;
+    xo: Record<string, unknown>;
+    devDependencies: Record<string, string>;
+    engines: {
+        node: ">=18";
+    };
+    publishConfig: {
+        access: "public";
+    };
+    private?: boolean | undefined;
+    exports?: string | undefined;
+    files?: ["./dist/**/!(*.test).{js,d.ts,cjs}", ...string[]] | undefined;
+    ava?: Record<string, unknown> | undefined;
+    c8?: Record<string, unknown> | undefined;
+    dependencies?: Record<string, string> | undefined;
+}, {
+    type: "module";
+    description: string;
+    author: string;
+    name: string;
+    release: Record<string, unknown>;
+    version: string;
+    homepage: string;
+    bugs: {
+        url: string;
+    };
+    repository: {
+        type: "git";
+        url: string;
+    };
+    license: "GPL-3.0-or-later";
+    prettier: Record<string, unknown>;
+    scripts: {
+        format: string;
+        lint: "npm run format:check && xo";
+        build: string;
+        test: string;
+        'format:check': string;
+        'lint:fix': "npm run format && xo --fix";
+        prepare: "husky install .github/husky";
+    };
+    commitlint: Record<string, unknown>;
+    xo: Record<string, unknown>;
+    devDependencies: Record<string, string>;
+    engines: {
+        node: ">=18";
+    };
+    publishConfig: {
+        access: "public";
+    };
+    private?: boolean | undefined;
+    exports?: string | undefined;
+    files?: ["./dist/**/!(*.test).{js,d.ts,cjs}", ...string[]] | undefined;
+    ava?: Record<string, unknown> | undefined;
+    c8?: Record<string, unknown> | undefined;
+    dependencies?: Record<string, string> | undefined;
+}>;
+type PackageJson = z.infer<typeof schema>;
+declare class Package extends File {
+    protected readonly _fullPackage: Required<PackageJson>;
+    protected readonly _package: PackageJson;
+    constructor(path: string, options: Options);
+    get package(): {
+        type: "module";
+        description: string;
+        author: string;
+        name: string;
+        release: Record<string, unknown>;
+        version: string;
+        homepage: string;
+        bugs: {
+            url: string;
+        };
+        repository: {
+            type: "git";
+            url: string;
+        };
+        license: "GPL-3.0-or-later";
+        prettier: Record<string, unknown>;
+        scripts: {
+            format: string;
+            lint: "npm run format:check && xo";
+            build: string;
+            test: string;
+            'format:check': string;
+            'lint:fix': "npm run format && xo --fix";
+            prepare: "husky install .github/husky";
+        };
+        commitlint: Record<string, unknown>;
+        xo: Record<string, unknown>;
+        devDependencies: Record<string, string>;
+        engines: {
+            node: ">=18";
+        };
+        publishConfig: {
+            access: "public";
+        };
+        private?: boolean | undefined;
+        exports?: string | undefined;
+        files?: ["./dist/**/!(*.test).{js,d.ts,cjs}", ...string[]] | undefined;
+        ava?: Record<string, unknown> | undefined;
+        c8?: Record<string, unknown> | undefined;
+        dependencies?: Record<string, string> | undefined;
+    };
+    process(): this;
+}
+export { Package, type PackageJson };

package/dist/content/package.js

@@ -0,0 +1,122 @@
+import { z } from 'zod';
+import { sortPackageJson } from 'sort-package-json';
+import { File } from './file.js';
+const schema = z
+    .object({
+    name: z.string().min(1),
+    version: z.string().min('0.0.0'.length),
+    description: z.string(),
+    private: z.boolean().optional(),
+    homepage: z.string().url(),
+    bugs: z
+        .object({
+        url: z.string().url(),
+    })
+        .strict(),
+    repository: z
+        .object({
+        type: z.literal('git'),
+        url: z.string().url(),
+    })
+        .strict(),
+    license: z.literal('GPL-3.0-or-later'),
+    author: z.string().min(1),
+    type: z.literal('module'),
+    exports: z.string().min(1).optional(),
+    files: z
+        .tuple([z.literal('./dist/**/!(*.test).{js,d.ts,cjs}')])
+        .rest(z.string().min(1))
+        .optional(),
+    scripts: z
+        .object({
+        build: z.string().min(1),
+        format: z.string().startsWith('prettier'),
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        'format:check': z.string().startsWith('prettier'),
+        lint: z.literal('npm run format:check && xo'),
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        'lint:fix': z.literal('npm run format && xo --fix'),
+        prepare: z.literal('husky install .github/husky'),
+        test: z.string().min(1),
+    })
+        .strict(),
+    commitlint: z.record(z.unknown()),
+    xo: z.record(z.unknown()),
+    prettier: z.record(z.unknown()),
+    release: z.record(z.unknown()),
+    ava: z.record(z.unknown()).optional(),
+    c8: z.record(z.unknown()).optional(),
+    dependencies: z.record(z.string()).optional(),
+    devDependencies: z.record(z.string()),
+    engines: z.object({ node: z.literal('>=18') }).strict(),
+    publishConfig: z.object({ access: z.literal('public') }).strict(),
+})
+    .strict();
+class Package extends File {
+    _fullPackage;
+    _package;
+    constructor(path, options) {
+        super(path, { ...options, format: true });
+        this._fullPackage = schema.required().parse(JSON.parse(this._content));
+        this._package = structuredClone(this._fullPackage);
+    }
+    get package() {
+        return structuredClone(this._package);
+    }
+    process() {
+        this._package.name = this._options.package;
+        this._package.version = '0.1.0';
+        this._package.description = this._options.description;
+        this._package.author = this._options.author;
+        this._package.devDependencies = {
+            ...this._package.devDependencies,
+            ...this._package.dependencies,
+        };
+        delete this._package.dependencies;
+        if (this._options.public) {
+            delete this._package.private;
+        }
+        else {
+            this._package.private = true;
+        }
+        const devDependencies = [
+            '@commitlint/cli',
+            '@semantic-release/changelog',
+            '@semantic-release/exec',
+            '@semantic-release/git',
+            '@vidavidorra/commitlint-config',
+            'husky',
+            'lint-staged',
+            'semantic-release',
+            'xo',
+        ];
+        if (this._options.typescript) {
+            this._package.files = [this._fullPackage.files[0]];
+            devDependencies.push('typescript');
+        }
+        else {
+            this._package.scripts.build = '';
+            delete this._package.exports;
+            delete this._package.files;
+        }
+        if (this._options.testing) {
+            devDependencies.push('@ava/typescript', 'ava', 'c8');
+        }
+        else {
+            this._package.scripts.test = '';
+            delete this._package.ava;
+            delete this._package.c8;
+        }
+        for (const dependency of Object.keys(this._package.devDependencies)) {
+            if (!devDependencies.includes(dependency)) {
+                // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+                delete this._package.devDependencies[dependency];
+            }
+        }
+        sortPackageJson(this._package);
+        this._content = JSON.stringify(this._package, undefined, 2);
+        return this;
+    }
+}
+export { Package };
+//# sourceMappingURL=package.js.map

package/dist/content/readme/badge.d.ts

@@ -0,0 +1,15 @@
+import { type Options } from '../../options.js';
+type Config = Record<'conventionalCommits' | 'xo' | 'prettier' | 'renovate' | 'semanticRelease' | 'codeCoverage' | 'license' | 'npmVersion' | 'npmDownloads' | 'nodeJsVersion', {
+    title: string;
+    url: string;
+    link: string;
+}>;
+declare class Badge {
+    private readonly _options;
+    constructor(options: Options);
+    markdown(key: keyof Config): string;
+    get badges(): Array<keyof Config>;
+    private get config();
+    private get gitHubRepository();
+}
+export { Badge };

package/dist/content/readme/badge.js

@@ -0,0 +1,75 @@
+class Badge {
+    _options;
+    constructor(options) {
+        this._options = options;
+    }
+    markdown(key) {
+        const config = this.config[key];
+        const url = new URL(config.url);
+        url.searchParams.append('style', 'flat-square');
+        return `[![${config.title}](${url.toString()})](${config.link})`;
+    }
+    get badges() {
+        return Object.keys(this.config);
+    }
+    get config() {
+        return {
+            conventionalCommits: {
+                title: 'Conventional Commits: 1.0.0',
+                url: 'https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow',
+                link: 'https://conventionalcommits.org',
+            },
+            xo: {
+                title: 'XO code style',
+                url: 'https://img.shields.io/badge/code_style-5ed9c7?logo=xo&labelColor=gray',
+                link: 'https://github.com/xojs/xo',
+            },
+            prettier: {
+                title: 'Prettier code style',
+                url: 'https://img.shields.io/badge/code_style-Prettier-ff69b4?logo=prettier',
+                link: 'https://github.com/prettier/prettier',
+            },
+            renovate: {
+                title: 'Renovate',
+                url: 'https://img.shields.io/badge/Renovate-enabled-brightgreen?logo=renovatebot&logoColor',
+                link: 'https://renovatebot.com',
+            },
+            semanticRelease: {
+                title: 'semantic-release',
+                url: 'https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079',
+                link: 'https://github.com/semantic-release/semantic-release',
+            },
+            codeCoverage: {
+                title: 'Code coverage',
+                url: `https://img.shields.io/codecov/c/github${this.gitHubRepository}?logo=codecov`,
+                link: `https://codecov.io/gh/${this.gitHubRepository}`,
+            },
+            license: {
+                title: 'License',
+                url: `https://img.shields.io/github/license${this.gitHubRepository}`,
+                link: `LICENSE.md`,
+            },
+            npmVersion: {
+                title: 'npm version',
+                url: `https://img.shields.io/npm/v/${this._options.package}?logo=npm`,
+                link: `https://www.npmjs.com/package/${this._options.package}`,
+            },
+            npmDownloads: {
+                title: 'npm downloads',
+                url: `https://img.shields.io/npm/dm/${this._options.package}?logo=npm`,
+                link: `https://www.npmjs.com/package/${this._options.package}`,
+            },
+            nodeJsVersion: {
+                title: 'Node.js version support',
+                url: `https://img.shields.io/node/v/${this._options.package}?logo=node.js`,
+                link: `https://nodejs.org/en/about/releases/`,
+            },
+        };
+    }
+    get gitHubRepository() {
+        const { githubOwner, githubRepository } = this._options;
+        return `${githubOwner}/${githubRepository}`;
+    }
+}
+export { Badge };
+//# sourceMappingURL=badge.js.map

package/dist/content/readme/index.d.ts

@@ -0,0 +1 @@
+export { Readme } from './readme.js';

package/dist/content/readme/index.js

@@ -0,0 +1,2 @@
+export { Readme } from './readme.js';
+//# sourceMappingURL=index.js.map

package/dist/content/readme/readme.d.ts

@@ -0,0 +1,17 @@
+import { type Options } from '../../options.js';
+import { File } from '../file.js';
+declare class Readme extends File {
+    private readonly _badge;
+    constructor(path: string, options: Options);
+    process(): this;
+    private badges;
+    private tableOfContents;
+    private install;
+    private usage;
+    private contributing;
+    private securityPolicy;
+    private license;
+    private dedent;
+    private gitHubUrl;
+}
+export { Readme };

package/dist/content/readme/readme.js

@@ -0,0 +1,129 @@
+import { File } from '../file.js';
+import { Badge } from './badge.js';
+class Readme extends File {
+    _badge;
+    constructor(path, options) {
+        super(path, { ...options, format: true });
+        this._badge = new Badge(options);
+    }
+    process() {
+        this._content = [
+            `# ${this.options.project} <!-- omit in toc -->`,
+            `${this.options.description}`,
+            '---',
+            this.badges(),
+            this.tableOfContents(),
+            this.install(),
+            this.usage(),
+            this.contributing(),
+            this.securityPolicy(),
+            this.license(),
+        ].join('\n\n');
+        return this;
+    }
+    badges() {
+        return [
+            this._options.public ? this._badge.markdown('npmVersion') : undefined,
+            this._options.public ? this._badge.markdown('npmDownloads') : undefined,
+            this._options.public ? this._badge.markdown('nodeJsVersion') : undefined,
+            this._badge.markdown('renovate'),
+            this._badge.markdown('semanticRelease'),
+            this._options.reportCodeCoverage
+                ? this._badge.markdown('codeCoverage')
+                : undefined,
+            this._badge.markdown('license'),
+        ].join('\n');
+    }
+    tableOfContents() {
+        return this.dedent(`- [Install](#install)
+      - [Usage](#usage)
+      - [Contributing](#contributing)
+      - [Security policy](#security-policy)
+      - [License](#license)`);
+    }
+    install() {
+        return this.dedent(`## Install
+
+        ...`);
+    }
+    usage() {
+        return this.dedent(`## Usage
+
+      ...`);
+    }
+    contributing() {
+        const contributingGuide = this.gitHubUrl('blob/main/CONTRIBUTING.md', '.github');
+        return this.dedent(`## Contributing
+
+      ${[
+            `Please [create an issue](${this.gitHubUrl('issues/new/choose')})`,
+            'if you have a bug report or feature proposal, or',
+            `[create a discussion](${this.gitHubUrl('discussions')} if you have a`,
+            'question. If you like this project, please consider giving it a star',
+            '⭐ to support my work.',
+        ].join(' ')}
+
+      ${[
+            `Refer to the, [contributing guide](${contributingGuide})`,
+            'for detailed information about other contributions, like pull',
+            'requests.',
+        ].join(' ')}
+
+      ${this._badge.markdown('conventionalCommits')}
+      ${this._badge.markdown('xo')}
+      ${this._badge.markdown('prettier')}`);
+    }
+    securityPolicy() {
+        return this.dedent(`## Security policy
+      ${[
+            'Please refer to the',
+            `[Security Policy on GitHub](${this.gitHubUrl('security')})`,
+            'for the security policy.',
+        ].join(' ')}`);
+    }
+    license() {
+        return this.dedent(`## License
+
+      ${[
+            'This project is licensed under the',
+            '[GPLv3 license](https://www.gnu.org/licenses/gpl.html).',
+        ].join(' ')}
+
+      Copyright © ${new Date().getFullYear()} ${this.options.author}
+
+      <details><summary>License notice</summary>
+      <p>
+
+      This program is free software: you can redistribute it and/or modify
+      it under the terms of the GNU General Public License as published by
+      the Free Software Foundation, either version 3 of the License, or
+      (at your option) any later version.
+
+      This program is distributed in the hope that it will be useful,
+      but WITHOUT ANY WARRANTY; without even the implied warranty of
+      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+      GNU General Public License for more details.
+
+      You should have received a copy of the GNU General Public License
+      along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+      ${[
+            'The full text of the license is available in the',
+            '[LICENSE](LICENSE.md) file in this repository and',
+            '[online](https://www.gnu.org/licenses/gpl.html)',
+        ].join(' ')}
+
+      </details>
+
+      <!-- References -->`);
+    }
+    dedent(value) {
+        return value.replaceAll(/^ +/gm, '');
+    }
+    gitHubUrl(path, repository) {
+        const { githubOwner: owner, githubRepository } = this._options;
+        return new URL(path, `https://github.com/${`${owner}/${repository ?? githubRepository}`}/`).toString();
+    }
+}
+export { Readme };
+//# sourceMappingURL=readme.js.map

package/dist/content/readme/readme.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readme.js","sourceRoot":"","sources":["../../../src/content/readme/readme.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,IAAI,EAAC,MAAM,YAAY,CAAC;AAChC,OAAO,EAAC,KAAK,EAAC,MAAM,YAAY,CAAC;AAEjC,MAAM,MAAO,SAAQ,IAAI;IACN,MAAM,CAAQ;IAE/B,YAAY,IAAY,EAAE,OAAgB;QACxC,KAAK,CAAC,IAAI,EAAE,EAAC,GAAG,OAAO,EAAE,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAEQ,OAAO;QACd,IAAI,CAAC,QAAQ,GAAG;YACd,KAAK,IAAI,CAAC,OAAO,CAAC,OAAO,uBAAuB;YAChD,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;YAC7B,KAAK;YACL,IAAI,CAAC,MAAM,EAAE;YACb,IAAI,CAAC,eAAe,EAAE;YACtB,IAAI,CAAC,OAAO,EAAE;YACd,IAAI,CAAC,KAAK,EAAE;YACZ,IAAI,CAAC,YAAY,EAAE;YACnB,IAAI,CAAC,cAAc,EAAE;YACrB,IAAI,CAAC,OAAO,EAAE;SACf,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM;QACZ,OAAO;YACL,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS;YACrE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS;YACvE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS;YACxE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC;YACvC,IAAI,CAAC,QAAQ,CAAC,kBAAkB;gBAC9B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC;gBACtC,CAAC,CAAC,SAAS;YACb,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;SAChC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;IAEO,eAAe;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC;;;;4BAIK,CAAC,CAAC;IAC5B,CAAC;IAEO,OAAO;QACb,OAAO,IAAI,CAAC,MAAM,CAAC;;YAEX,CAAC,CAAC;IACZ,CAAC;IAEO,KAAK;QACX,OAAO,IAAI,CAAC,MAAM,CAAC;;UAEb,CAAC,CAAC;IACV,CAAC;IAEO,YAAY;QAClB,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CACtC,2BAA2B,EAC3B,SAAS,CACV,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC;;QAEf;YACA,4BAA4B,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,GAAG;YAClE,kDAAkD;YAClD,yBAAyB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,gBAAgB;YACtE,sEAAsE;YACtE,uBAAuB;SACxB,CAAC,IAAI,CAAC,GAAG,CAAC;;QAET;YACA,sCAAsC,iBAAiB,GAAG;YAC1D,+DAA+D;YAC/D,WAAW;SACZ,CAAC,IAAI,CAAC,GAAG,CAAC;;QAET,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC1C,CAAC;IAEO,cAAc;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC;QACf;YACA,qBAAqB;YACrB,+BAA+B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG;YAC5D,0BAA0B;SAC3B,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;IAEO,OAAO;QACb,OAAO,IAAI,CAAC,MAAM,CAAC;;QAEf;YACA,oCAAoC;YACpC,yDAAyD;SAC1D,CAAC,IAAI,CAAC,GAAG,CAAC;;oBAEG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM;;;;;;;;;;;;;;;;;;QAkB3D;YACA,kDAAkD;YAClD,mDAAmD;YACnD,iDAAiD;SAClD,CAAC,IAAI,CAAC,GAAG,CAAC;;;;0BAIS,CAAC,CAAC;IAC1B,CAAC;IAEO,MAAM,CAAC,KAAa;QAC1B,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACvC,CAAC;IAEO,SAAS,CAAC,IAAY,EAAE,UAAmB;QACjD,MAAM,EAAC,WAAW,EAAE,KAAK,EAAE,gBAAgB,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7D,OAAO,IAAI,GAAG,CACZ,IAAI,EACJ,sBAAsB,GAAG,KAAK,IAAI,UAAU,IAAI,gBAAgB,EAAE,GAAG,CACtE,CAAC,QAAQ,EAAE,CAAC;IACf,CAAC;CACF;AAED,OAAO,EAAC,MAAM,EAAC,CAAC"}

package/dist/content/readme/readme.test.d.ts

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

package/dist/content/readme/readme.test.js

@@ -0,0 +1,35 @@
+import test from 'ava';
+import { options } from '../../_options.test.js';
+import { Readme } from './readme.js';
+const path = '.github/lint-staged.js';
+test('enables the "format" option', (t) => {
+    t.true(new Readme(path, options).options.format);
+});
+test('starts with project title, omitted in the table of contents', (t) => {
+    const file = new Readme(path, options).process();
+    t.is(file.content.split('\n').at(0), `# ${options.project} <!-- omit in toc -->`);
+});
+const includesBadge = test.macro({
+    exec(t, include, option, value) {
+        const file = new Readme(path, { ...options, [option]: include }).process();
+        (include ? t.regex : t.notRegex)(file.content, new RegExp(value));
+    },
+    title: (_, include, option, value) => [
+        `${include ? 'includes' : 'does not include'} "${value}"`,
+        `${include ? 'with' : 'without'} "${option}" option`,
+    ].join(' '),
+});
+test(includesBadge, true, 'public', 'npm version');
+test(includesBadge, false, 'public', 'npm version');
+test(includesBadge, true, 'public', 'npm downloads');
+test(includesBadge, false, 'public', 'npm downloads');
+test(includesBadge, true, 'public', 'Node.js version support');
+test(includesBadge, false, 'public', 'Node.js version support');
+test(includesBadge, true, 'reportCodeCoverage', 'Code coverage');
+test(includesBadge, false, 'reportCodeCoverage', 'Code coverage');
+test('contains a copyright with the current year and author', (t) => {
+    const file = new Readme(path, options).process();
+    const year = new Date().getFullYear();
+    t.regex(file.content, new RegExp(`Copyright © ${year} ${options.author}`));
+});
+//# sourceMappingURL=readme.test.js.map

package/dist/content/readme/readme.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readme.test.js","sourceRoot":"","sources":["../../../src/content/readme/readme.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,KAAK,CAAC;AACvB,OAAO,EAAC,OAAO,EAAC,MAAM,wBAAwB,CAAC;AAE/C,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AAEnC,MAAM,IAAI,GAAG,wBAAwB,CAAC;AAEtC,IAAI,CAAC,6BAA6B,EAAE,CAAC,CAAC,EAAE,EAAE;IACxC,CAAC,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACnD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6DAA6D,EAAE,CAAC,CAAC,EAAE,EAAE;IACxE,MAAM,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;IACjD,CAAC,CAAC,EAAE,CACF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAC9B,KAAK,OAAO,CAAC,OAAO,uBAAuB,CAC5C,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAmC;IACjE,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK;QAC5B,MAAM,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,EAAC,GAAG,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACzE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,KAAK,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CACnC;QACE,GAAG,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,kBAAkB,KAAK,KAAK,GAAG;QACzD,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,KAAK,MAAM,UAAU;KACrD,CAAC,IAAI,CAAC,GAAG,CAAC;CACd,CAAC,CAAC;AAEH,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;AACnD,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;AACpD,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;AACrD,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;AACtD,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,yBAAyB,CAAC,CAAC;AAC/D,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,QAAQ,EAAE,yBAAyB,CAAC,CAAC;AAChE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,oBAAoB,EAAE,eAAe,CAAC,CAAC;AACjE,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,oBAAoB,EAAE,eAAe,CAAC,CAAC;AAElE,IAAI,CAAC,uDAAuD,EAAE,CAAC,CAAC,EAAE,EAAE;IAClE,MAAM,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;IACjD,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,MAAM,CAAC,eAAe,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAC7E,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

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