@vidavidorra/create-project 1.0.1 → 1.0.3

package/README.md

@@ -9,7 +9,7 @@ Interactively create a project.
 
 [![npm version](https://img.shields.io/npm/v/@vidavidorra/create-project?logo=npm&style=flat-square)](https://www.npmjs.com/package/@vidavidorra/create-project)
 [![npm downloads](https://img.shields.io/npm/dm/@vidavidorra/create-project?logo=npm&style=flat-square)](https://www.npmjs.com/package/@vidavidorra/create-project)
-[![Node.js version support](https://img.shields.io/node/v/@vidavidorracreate-project?logo=node.js&style=flat-square)](https://nodejs.org/en/about/releases/)
+[![Node.js version support](https://img.shields.io/node/v/@vidavidorra/create-project?logo=node.js&style=flat-square)](https://nodejs.org/en/about/releases/)
 [![Renovate enabled](https://img.shields.io/badge/Renovate-enabled-brightgreen?logo=renovatebot&logoColor&style=flat-square)](https://renovatebot.com)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079?style=flat-square)](https://github.com/semantic-release/semantic-release)
 [![Code coverage](https://img.shields.io/codecov/c/github/vidavidorra/create-project?logo=codecov&style=flat-square)](https://codecov.io/gh/vidavidorra/create-project)
@@ -32,7 +32,13 @@ npm install --global @vidavidorra/create-project
 Start the interactive CLI to create a project.
 
 ```shell
-@vidavidorra/create-project
+create-project
+```
+
+Or run the interactive CLI directly via `npx`.
+
+```shell
+npx @vidavidorra/create-project
 ```
 
 ## Contributing

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,64 @@
+#!/usr/bin/env node
+import { input, confirm } from '@inquirer/prompts';
+import { createProject, options as schema } from './index.js';
+function validate(value, option) {
+    const validation = schema.shape[option].safeParse(value);
+    return validation.success
+        ? true
+        : validation.error.errors.map(({ message }) => message).join('\n> ');
+}
+const project = await input({
+    message: 'Project name:',
+    validate: (value) => validate(value, 'project'),
+});
+const name = project.replaceAll(' ', '-').toLowerCase();
+const defaultPackage = validate(name, 'package') === true ? name : undefined;
+const options = {
+    project,
+    package: await input({
+        message: 'Package name:',
+        validate: (value) => validate(value, 'package'),
+        default: defaultPackage,
+    }),
+    public: await confirm({
+        message: 'Make package public?',
+        default: schema.shape.public._def.defaultValue(),
+    }),
+    description: await input({
+        message: 'Description:',
+        validate: (value) => validate(value, 'description'),
+    }),
+    author: await input({
+        message: 'Author:',
+        validate: (value) => validate(value, 'author'),
+    }),
+    githubOwner: await input({
+        message: 'GitHub owner:',
+        validate: (value) => validate(value, 'githubOwner'),
+    }),
+    githubRepository: await input({
+        message: 'GitHub repository:',
+        validate: (value) => validate(value, 'githubRepository'),
+        default: validate(defaultPackage, 'githubRepository') === true
+            ? defaultPackage
+            : undefined,
+    }),
+};
+options.typescript = await confirm({ message: 'Add typescript?' });
+if (options.typescript) {
+    options.testing = await confirm({ message: 'Add AVA testing framework?' });
+}
+if (options.testing) {
+    options.reportCodeCoverage = await confirm({
+        message: 'Report code coverate to Codecov?',
+    });
+}
+options.path = await input({ message: 'Output folder:' });
+options.dryRun = await confirm({ message: 'Dry run?' });
+const files = await createProject(schema.parse(options));
+if (options.dryRun) {
+    for (const path of files) {
+        console.log(`Create file ${path}`);
+    }
+}
+//# sourceMappingURL=cli.js.map

package/dist/content/package.d.ts

@@ -28,6 +28,7 @@ declare const schema: z.ZodObject<{
     author: z.ZodString;
     type: z.ZodLiteral<"module">;
     exports: z.ZodOptional<z.ZodString>;
+    bin: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     files: z.ZodOptional<z.ZodTuple<[z.ZodLiteral<"./dist/**/!(*.test).{js,d.ts,cjs}">], z.ZodString>>;
     scripts: z.ZodObject<{
         build: z.ZodString;
@@ -35,6 +36,7 @@ declare const schema: z.ZodObject<{
         'format:check': z.ZodString;
         lint: z.ZodLiteral<"npm run format:check && xo">;
         'lint:fix': z.ZodLiteral<"npm run format && xo --fix">;
+        postinstall: z.ZodOptional<z.ZodString>;
         prepare: z.ZodLiteral<"husky install .github/husky">;
         test: z.ZodString;
     }, "strict", z.ZodTypeAny, {
@@ -45,6 +47,7 @@ declare const schema: z.ZodObject<{
         'format:check': string;
         'lint:fix': "npm run format && xo --fix";
         prepare: "husky install .github/husky";
+        postinstall?: string | undefined;
     }, {
         format: string;
         lint: "npm run format:check && xo";
@@ -53,6 +56,7 @@ declare const schema: z.ZodObject<{
         'format:check': string;
         'lint:fix': "npm run format && xo --fix";
         prepare: "husky install .github/husky";
+        postinstall?: string | undefined;
     }>;
     commitlint: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     xo: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -101,6 +105,7 @@ declare const schema: z.ZodObject<{
         'format:check': string;
         'lint:fix': "npm run format && xo --fix";
         prepare: "husky install .github/husky";
+        postinstall?: string | undefined;
     };
     commitlint: Record<string, unknown>;
     xo: Record<string, unknown>;
@@ -110,6 +115,7 @@ declare const schema: z.ZodObject<{
     };
     private?: boolean | undefined;
     exports?: string | undefined;
+    bin?: Record<string, unknown> | undefined;
     files?: ["./dist/**/!(*.test).{js,d.ts,cjs}", ...string[]] | undefined;
     ava?: Record<string, unknown> | undefined;
     c8?: Record<string, unknown> | undefined;
@@ -142,6 +148,7 @@ declare const schema: z.ZodObject<{
         'format:check': string;
         'lint:fix': "npm run format && xo --fix";
         prepare: "husky install .github/husky";
+        postinstall?: string | undefined;
     };
     commitlint: Record<string, unknown>;
     xo: Record<string, unknown>;
@@ -151,6 +158,7 @@ declare const schema: z.ZodObject<{
     };
     private?: boolean | undefined;
     exports?: string | undefined;
+    bin?: Record<string, unknown> | undefined;
     files?: ["./dist/**/!(*.test).{js,d.ts,cjs}", ...string[]] | undefined;
     ava?: Record<string, unknown> | undefined;
     c8?: Record<string, unknown> | undefined;
@@ -189,6 +197,7 @@ declare class Package extends File {
             'format:check': string;
             'lint:fix': "npm run format && xo --fix";
             prepare: "husky install .github/husky";
+            postinstall?: string | undefined;
         };
         commitlint: Record<string, unknown>;
         xo: Record<string, unknown>;
@@ -198,6 +207,7 @@ declare class Package extends File {
         };
         private?: boolean | undefined;
         exports?: string | undefined;
+        bin?: Record<string, unknown> | undefined;
         files?: ["./dist/**/!(*.test).{js,d.ts,cjs}", ...string[]] | undefined;
         ava?: Record<string, unknown> | undefined;
         c8?: Record<string, unknown> | undefined;

package/dist/content/package.js

@@ -23,6 +23,7 @@ const schema = z
     author: z.string().min(1),
     type: z.literal('module'),
     exports: z.string().min(1).optional(),
+    bin: z.record(z.unknown()).optional(),
     files: z
         .tuple([z.literal('./dist/**/!(*.test).{js,d.ts,cjs}')])
         .rest(z.string().min(1))
@@ -36,6 +37,7 @@ const schema = z
         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'),
+        postinstall: z.string().optional(),
         prepare: z.literal('husky install .github/husky'),
         test: z.string().min(1),
     })
@@ -75,7 +77,9 @@ class Package extends File {
             ...this._package.devDependencies,
             ...this._package.dependencies,
         };
+        delete this._package.bin;
         delete this._package.dependencies;
+        delete this._package.scripts.postinstall;
         if (this._options.public) {
             delete this._package.private;
         }

package/dist/create-project.d.ts

@@ -0,0 +1,3 @@
+import { type OptionsInput as Options } from './options.js';
+declare function createProject(options: Options): Promise<string[]>;
+export { createProject };

package/dist/create-project.js

@@ -0,0 +1,12 @@
+import { schema } from './options.js';
+import { files } from './content/index.js';
+async function createProject(options) {
+    const paths = [];
+    for await (const file of files(schema.parse(options))) {
+        await file.write();
+        paths.push(file.path);
+    }
+    return paths;
+}
+export { createProject };
+//# sourceMappingURL=create-project.js.map

package/dist/index.d.ts

@@ -1 +1,2 @@
-export {};
+export { type OptionsInput as Options, options } from './options.js';
+export { createProject } from './create-project.js';

package/dist/index.js

@@ -1,62 +1,3 @@
-import { input, confirm } from '@inquirer/prompts';
-import { schema } from './options.js';
-import { files } from './content/index.js';
-function validate(value, option) {
-    const validation = schema.shape[option].safeParse(value);
-    return validation.success
-        ? true
-        : validation.error.errors.map(({ message }) => message).join('\n> ');
-}
-const project = await input({
-    message: 'Project name:',
-    validate: (value) => validate(value, 'project'),
-});
-const name = project.replaceAll(' ', '-').toLowerCase();
-const defaultPackage = validate(name, 'package') === true ? name : undefined;
-const options = {
-    project,
-    package: await input({
-        message: 'Package name:',
-        validate: (value) => validate(value, 'package'),
-        default: defaultPackage,
-    }),
-    public: await confirm({
-        message: 'Make package public?',
-        default: schema.shape.public._def.defaultValue(),
-    }),
-    description: await input({
-        message: 'Description:',
-        validate: (value) => validate(value, 'description'),
-    }),
-    author: await input({
-        message: 'Author:',
-        validate: (value) => validate(value, 'author'),
-    }),
-    githubOwner: await input({
-        message: 'GitHub owner:',
-        validate: (value) => validate(value, 'githubOwner'),
-    }),
-    githubRepository: await input({
-        message: 'GitHub repository:',
-        validate: (value) => validate(value, 'githubRepository'),
-        default: validate(defaultPackage, 'githubRepository') === true
-            ? defaultPackage
-            : undefined,
-    }),
-};
-options.typescript = await confirm({ message: 'Add typescript?' });
-if (options.typescript) {
-    options.testing = await confirm({ message: 'Add AVA testing framework?' });
-}
-if (options.testing) {
-    options.reportCodeCoverage = await confirm({
-        message: 'Report code coverate to Codecov?',
-    });
-}
-options.path = await input({ message: 'Output folder:' });
-options.dryRun = await confirm({ message: 'Dry run?' });
-for await (const file of files(schema.parse(options))) {
-    console.log(`Create file ${file.path}`);
-    await file.write();
-}
+export { options } from './options.js';
+export { createProject } from './create-project.js';
 //# sourceMappingURL=index.js.map

package/dist/options.d.ts

@@ -39,5 +39,6 @@ declare const schema: z.ZodObject<{
     reportCodeCoverage?: boolean | undefined;
     dryRun?: boolean | undefined;
 }>;
+type OptionsInput = z.input<typeof schema>;
 type Options = z.infer<typeof schema>;
-export { schema, schema as options, type Options };
+export { schema, schema as options, type Options, type OptionsInput };

package/dist/scripts/postinstall.d.ts

@@ -0,0 +1,13 @@
+declare const gitIgnore: string;
+declare const npmIgnore: string;
+/**
+ * Workaround for [Rename `.gitignore` to `.npmignore` in package if no
+ * `.npmignore` found](https://github.com/npm/npm/issues/1862) and ['npm pack'/
+ * `publish` option to not rename or keep a copy of `.gitignore` files](
+ * https://github.com/npm/npm/issues/7252) issues. With npm v9 or newer, the
+ * `npm pack` includes the `.gitignore` in the tarball and `npm install` renames
+ * the file to `.npmignore`. This script simply reverts that rename if it has
+ * occurred.
+ */
+declare function postinstall(): void;
+export { gitIgnore, npmIgnore, postinstall };

package/dist/scripts/postinstall.js

@@ -0,0 +1,27 @@
+import { join } from 'node:path';
+import fs from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import { argv } from 'node:process';
+import rootPath from '../root-path.js';
+const gitIgnore = join(rootPath, '.gitignore');
+const npmIgnore = join(rootPath, '.npmignore');
+/**
+ * Workaround for [Rename `.gitignore` to `.npmignore` in package if no
+ * `.npmignore` found](https://github.com/npm/npm/issues/1862) and ['npm pack'/
+ * `publish` option to not rename or keep a copy of `.gitignore` files](
+ * https://github.com/npm/npm/issues/7252) issues. With npm v9 or newer, the
+ * `npm pack` includes the `.gitignore` in the tarball and `npm install` renames
+ * the file to `.npmignore`. This script simply reverts that rename if it has
+ * occurred.
+ */
+function postinstall() {
+    if (fs.existsSync(npmIgnore) && !fs.existsSync(gitIgnore)) {
+        fs.renameSync(npmIgnore, gitIgnore);
+    }
+}
+if (import.meta.url.startsWith('file:') &&
+    fileURLToPath(import.meta.url) === argv.at(1)) {
+    postinstall();
+}
+export { gitIgnore, npmIgnore, postinstall };
+//# sourceMappingURL=postinstall.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vidavidorra/create-project",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "private": false,
   "description": "Interactively create a GitHub project.",
   "homepage": "https://github.com/vidavidorra/create-project#readme",
@@ -15,6 +15,9 @@
   "author": "Jeroen de Bruijn",
   "type": "module",
   "exports": "./dist/index.js",
+  "bin": {
+    "create-project": "./dist/cli.js"
+  },
   "files": [
     "./dist/**/!(*.test).{js,d.ts,cjs}",
     "./.github/",
@@ -28,6 +31,7 @@
     "build": "tsc",
     "format": "prettier --ignore-path .gitignore --write \"**/*.{vue,css,less,scss,html,htm,json,md,markdown,yml,yaml}\" --log-level warn",
     "format:check": "prettier --ignore-path .gitignore --check \"**/*.{vue,css,less,scss,html,htm,json,md,markdown,yml,yaml}\" --log-level warn",
+    "postinstall": "node ./dist/scripts/postinstall.js",
     "lint": "npm run format:check && xo",
     "lint:fix": "npm run format && xo --fix",
     "prepare": "husky install .github/husky",
@@ -179,6 +183,7 @@
     }
   },
   "c8": {
+    "all": true,
     "include": [
       "dist/**/*.js"
     ],