@vltpkg/init 1.0.0-rc.8 → 1.0.1

package/README.md

@@ -7,7 +7,7 @@ Project initialization logic for `vlt`.
 ## Overview
 
 This is a tool that provides the project initialization logic used by
-the vlt cli and gui.
+the vlt cli.
 
 ## Usage
 

package/dist/{esm/get-author-from-git-user.d.ts → get-author-from-git-user.d.ts}

@@ -1,3 +1,2 @@
 import type { GitUser } from '@vltpkg/git';
 export declare const getAuthorFromGitUser: (user?: GitUser) => string;
-//# sourceMappingURL=get-author-from-git-user.d.ts.map

package/dist/{esm/get-author-from-git-user.js → get-author-from-git-user.js}

@@ -12,4 +12,3 @@ export const getAuthorFromGitUser = (user) => {
     }
     return res;
 };
-//# sourceMappingURL=get-author-from-git-user.js.map

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import type { JSONObj } from '@vltpkg/registry-client';
+import type { NormalizedManifest } from '@vltpkg/types';
+import { getAuthorFromGitUser } from './get-author-from-git-user.ts';
+export { getAuthorFromGitUser };
+export type InitOptions = {
+    cwd?: string;
+    author?: string;
+    logger?: (...a: unknown[]) => void;
+};
+export type CustomizableInitOptions = {
+    name: string;
+    author: string;
+};
+export type JSONFileInfo<T extends JSONObj = JSONObj> = {
+    path: string;
+    data: T;
+};
+export type IgnoreFileInfo = {
+    path: string;
+};
+export type GitignoreFileInfo = IgnoreFileInfo;
+export type InitFileResults = {
+    manifest?: JSONFileInfo<NormalizedManifest>;
+    gitignore?: IgnoreFileInfo;
+    npmignore?: IgnoreFileInfo;
+};
+/**
+ * Create or update a `.gitignore` file ensuring `node_modules` is listed.
+ * Returns `{ path }` of the file that was written, or `undefined` if the
+ * file already contained the entry and no changes were needed.
+ */
+export declare const ensureGitignore: (cwd: string) => GitignoreFileInfo | undefined;
+/**
+ * Create or update a `.npmignore` file ensuring `vlt.json` is listed.
+ * Returns `{ path }` of the file that was written, or `undefined` if the
+ * file already contained the entry and no changes were needed.
+ */
+export declare const ensureNpmignore: (cwd: string) => IgnoreFileInfo | undefined;
+export declare const init: ({ cwd, author, logger, }?: InitOptions) => Promise<InitFileResults>;

package/dist/index.js

@@ -0,0 +1,90 @@
+import { getUser } from '@vltpkg/git';
+import { PackageJson } from '@vltpkg/package-json';
+import { appendFileSync, existsSync, readFileSync, writeFileSync, } from 'node:fs';
+import { basename, resolve } from 'node:path';
+import { getAuthorFromGitUser } from "./get-author-from-git-user.js";
+import { asError, normalizeManifest } from '@vltpkg/types';
+export { getAuthorFromGitUser };
+// eslint-disable-next-line no-console
+const stderr = console.error;
+const template = ({ name, author }) => normalizeManifest({
+    name,
+    version: '1.0.0',
+    description: '',
+    main: 'index.js',
+    ...(author ? { author } : undefined),
+});
+const GITIGNORE_ENTRY = 'node_modules';
+const NPMIGNORE_ENTRY = 'vlt.json';
+/**
+ * Create or update a `.gitignore` file ensuring `node_modules` is listed.
+ * Returns `{ path }` of the file that was written, or `undefined` if the
+ * file already contained the entry and no changes were needed.
+ */
+export const ensureGitignore = (cwd) => {
+    const gitignorePath = resolve(cwd, '.gitignore');
+    if (!existsSync(gitignorePath)) {
+        writeFileSync(gitignorePath, `${GITIGNORE_ENTRY}\n`, 'utf8');
+        return { path: gitignorePath };
+    }
+    const content = readFileSync(gitignorePath, 'utf8');
+    const lines = content.split('\n').map(l => l.trim());
+    if (!lines.includes(GITIGNORE_ENTRY)) {
+        // Append with a leading newline to avoid joining onto an existing last line
+        const prefix = content.endsWith('\n') ? '' : '\n';
+        appendFileSync(gitignorePath, `${prefix}${GITIGNORE_ENTRY}\n`, 'utf8');
+        return { path: gitignorePath };
+    }
+    return undefined;
+};
+/**
+ * Create or update a `.npmignore` file ensuring `vlt.json` is listed.
+ * Returns `{ path }` of the file that was written, or `undefined` if the
+ * file already contained the entry and no changes were needed.
+ */
+export const ensureNpmignore = (cwd) => {
+    const npmignorePath = resolve(cwd, '.npmignore');
+    if (!existsSync(npmignorePath)) {
+        writeFileSync(npmignorePath, `${NPMIGNORE_ENTRY}\n`, 'utf8');
+        return { path: npmignorePath };
+    }
+    const content = readFileSync(npmignorePath, 'utf8');
+    const lines = content.split('\n').map(l => l.trim());
+    if (!lines.includes(NPMIGNORE_ENTRY)) {
+        const prefix = content.endsWith('\n') ? '' : '\n';
+        appendFileSync(npmignorePath, `${prefix}${NPMIGNORE_ENTRY}\n`, 'utf8');
+        return { path: npmignorePath };
+    }
+    return undefined;
+};
+export const init = async ({ cwd = process.cwd(), author, logger = stderr, } = {}) => {
+    const packageJson = new PackageJson();
+    const path = resolve(cwd, 'package.json');
+    let existingData;
+    try {
+        existingData = packageJson.read(cwd);
+        logger('package.json already exists');
+    }
+    catch (err) {
+        if (asError(err).message !== 'Could not read package.json file') {
+            throw err;
+        }
+    }
+    const name = basename(cwd);
+    const templateData = template({
+        name,
+        author: author ??
+            getAuthorFromGitUser(await getUser().catch(() => undefined)),
+    });
+    // Merge template with existing data, preserving existing properties
+    const data = existingData ? { ...templateData, ...existingData } : templateData;
+    const indent = 2;
+    packageJson.write(cwd, data, indent);
+    const gitignore = ensureGitignore(cwd);
+    const npmignore = ensureNpmignore(cwd);
+    return {
+        manifest: { path, data },
+        ...(gitignore ? { gitignore } : {}),
+        ...(npmignore ? { npmignore } : {}),
+    };
+};

package/package.json

@@ -1,72 +1,70 @@
 {
   "name": "@vltpkg/init",
   "description": "vlt project intialization logic",
-  "version": "1.0.0-rc.8",
+  "version": "1.0.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vltpkg/vltpkg.git",
     "directory": "src/init"
   },
-  "author": "vlt technology inc. <support@vlt.sh> (http://vlt.sh)",
-  "tshy": {
-    "selfLink": false,
-    "liveDev": true,
-    "dialects": [
-      "esm"
-    ],
-    "exports": {
-      "./package.json": "./package.json",
-      ".": "./src/index.ts"
-    }
+  "author": {
+    "name": "vlt technology inc.",
+    "email": "support@vlt.sh",
+    "url": "http://vlt.sh"
   },
   "dependencies": {
-    "@vltpkg/git": "1.0.0-rc.8",
-    "@vltpkg/registry-client": "1.0.0-rc.8",
-    "@vltpkg/types": "1.0.0-rc.8",
-    "@vltpkg/package-json": "1.0.0-rc.8"
+    "@vltpkg/git": "1.0.1",
+    "@vltpkg/package-json": "1.0.1",
+    "@vltpkg/registry-client": "1.0.1",
+    "@vltpkg/types": "1.0.1"
   },
   "devDependencies": {
-    "@eslint/js": "^9.34.0",
-    "@types/node": "^22.17.2",
-    "eslint": "^9.34.0",
-    "prettier": "^3.6.2",
-    "tap": "^21.1.0",
-    "tshy": "^3.0.2",
+    "@eslint/js": "^9.39.1",
+    "@types/node": "^22.19.2",
+    "eslint": "^9.39.1",
+    "prettier": "^3.7.4",
+    "tap": "^21.5.0",
     "typedoc": "~0.27.9",
     "typescript": "5.7.3",
-    "typescript-eslint": "^8.40.0"
+    "typescript-eslint": "^8.49.0"
   },
   "license": "BSD-2-Clause-Patent",
   "engines": {
-    "node": ">=22"
+    "node": ">=22.22.0"
+  },
+  "scripts": {
+    "format": "prettier --write . --log-level warn --ignore-path ../../.prettierignore --cache",
+    "format:check": "prettier --check . --ignore-path ../../.prettierignore --cache",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
+    "prepack": "tsc -p tsconfig.publish.json && ../../scripts/update-dist-exports.ts",
+    "snap": "tap",
+    "test": "tap",
+    "posttest": "tsc --noEmit",
+    "typecheck": "tsc --noEmit"
   },
   "tap": {
     "extends": "../../tap-config.yaml"
   },
   "prettier": "../../.prettierrc.js",
-  "module": "./dist/esm/index.js",
+  "module": "./dist/index.js",
   "type": "module",
   "exports": {
     "./package.json": "./package.json",
     ".": {
       "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
+        "default": "./dist/index.js"
       }
     }
   },
   "files": [
     "dist"
   ],
-  "scripts": {
-    "format": "prettier --write . --log-level warn --ignore-path ../../.prettierignore --cache",
-    "format:check": "prettier --check . --ignore-path ../../.prettierignore --cache",
-    "lint": "eslint . --fix",
-    "lint:check": "eslint .",
-    "snap": "tap",
-    "test": "tap",
-    "posttest": "tsc --noEmit",
-    "tshy": "tshy",
-    "typecheck": "tsc --noEmit"
-  }
-}
+  "bugs": [
+    {
+      "type": "link",
+      "url": "https://github.com/vltpkg/vltpkg/issues"
+    }
+  ],
+  "homepage": "https://github.com/vltpkg/vltpkg/tree/main/src/init#readme"
+}

package/dist/esm/get-author-from-git-user.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-author-from-git-user.d.ts","sourceRoot":"","sources":["../../src/get-author-from-git-user.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAE1C,eAAO,MAAM,oBAAoB,UAAW,OAAO,KAAG,MAUrD,CAAA"}

package/dist/esm/get-author-from-git-user.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-author-from-git-user.js","sourceRoot":"","sources":["../../src/get-author-from-git-user.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAAc,EAAU,EAAE;IAC7D,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAA;IACpB,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAA;IAC5B,IAAI,GAAG,GAAG,EAAE,CAAA;IACZ,IAAI,IAAI;QAAE,GAAG,IAAI,IAAI,CAAA;IACrB,IAAI,KAAK,EAAE,CAAC;QACV,IAAI,IAAI;YAAE,GAAG,IAAI,GAAG,CAAA;QACpB,GAAG,IAAI,IAAI,KAAK,GAAG,CAAA;IACrB,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA","sourcesContent":["import type { GitUser } from '@vltpkg/git'\n\nexport const getAuthorFromGitUser = (user?: GitUser): string => {\n  if (!user) return ''\n  const { name, email } = user\n  let res = ''\n  if (name) res += name\n  if (email) {\n    if (name) res += ' '\n    res += `<${email}>`\n  }\n  return res\n}\n"]}

package/dist/esm/index.d.ts

@@ -1,22 +0,0 @@
-import type { JSONObj } from '@vltpkg/registry-client';
-import type { NormalizedManifest } from '@vltpkg/types';
-import { getAuthorFromGitUser } from './get-author-from-git-user.ts';
-export { getAuthorFromGitUser };
-export type InitOptions = {
-    cwd?: string;
-    author?: string;
-    logger?: (...a: unknown[]) => void;
-};
-export type CustomizableInitOptions = {
-    name: string;
-    author: string;
-};
-export type JSONFileInfo<T extends JSONObj = JSONObj> = {
-    path: string;
-    data: T;
-};
-export type InitFileResults = {
-    manifest?: JSONFileInfo<NormalizedManifest>;
-};
-export declare const init: ({ cwd, author, logger, }?: InitOptions) => Promise<InitFileResults>;
-//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAEvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAA;AAEpE,OAAO,EAAE,oBAAoB,EAAE,CAAA;AAK/B,MAAM,MAAM,WAAW,GAAG;IACxB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAWD,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI;IACtD,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,CAAA;CACR,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAAA;CAK5C,CAAA;AAED,eAAO,MAAM,IAAI,8BAId,WAAW,KAAQ,OAAO,CAAC,eAAe,CA6B5C,CAAA"}

package/dist/esm/index.js

@@ -1,41 +0,0 @@
-import { getUser } from '@vltpkg/git';
-import { PackageJson } from '@vltpkg/package-json';
-import { basename, resolve } from 'node:path';
-import { getAuthorFromGitUser } from "./get-author-from-git-user.js";
-import { asError, normalizeManifest } from '@vltpkg/types';
-export { getAuthorFromGitUser };
-// eslint-disable-next-line no-console
-const stderr = console.error;
-const template = ({ name, author }) => normalizeManifest({
-    name,
-    version: '1.0.0',
-    description: '',
-    main: 'index.js',
-    ...(author ? { author } : undefined),
-});
-export const init = async ({ cwd = process.cwd(), author, logger = stderr, } = {}) => {
-    const packageJson = new PackageJson();
-    const path = resolve(cwd, 'package.json');
-    let existingData;
-    try {
-        existingData = packageJson.read(cwd);
-        logger('package.json already exists');
-    }
-    catch (err) {
-        if (asError(err).message !== 'Could not read package.json file') {
-            throw err;
-        }
-    }
-    const name = basename(cwd);
-    const templateData = template({
-        name,
-        author: author ??
-            getAuthorFromGitUser(await getUser().catch(() => undefined)),
-    });
-    // Merge template with existing data, preserving existing properties
-    const data = existingData ? { ...templateData, ...existingData } : templateData;
-    const indent = 2;
-    packageJson.write(cwd, data, indent);
-    return { manifest: { path, data } };
-};
-//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAGlD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAC1D,OAAO,EAAE,oBAAoB,EAAE,CAAA;AAE/B,sCAAsC;AACtC,MAAM,MAAM,GAA8B,OAAO,CAAC,KAAK,CAAA;AAavD,MAAM,QAAQ,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAA2B,EAAE,EAAE,CAC7D,iBAAiB,CAAC;IAChB,IAAI;IACJ,OAAO,EAAE,OAAO;IAChB,WAAW,EAAE,EAAE;IACf,IAAI,EAAE,UAAU;IAChB,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;CACrC,CAAC,CAAA;AAeJ,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,EAAE,EACzB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,MAAM,EACN,MAAM,GAAG,MAAM,MACA,EAAE,EAA4B,EAAE;IAC/C,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAA;IACrC,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAA;IACzC,IAAI,YAA4C,CAAA;IAEhD,IAAI,CAAC;QACH,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACpC,MAAM,CAAC,6BAA6B,CAAC,CAAA;IACvC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,KAAK,kCAAkC,EAAE,CAAC;YAChE,MAAM,GAAG,CAAA;QACX,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;IAC1B,MAAM,YAAY,GAAG,QAAQ,CAAC;QAC5B,IAAI;QACJ,MAAM,EACJ,MAAM;YACN,oBAAoB,CAAC,MAAM,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;KAC/D,CAAC,CAAA;IAEF,oEAAoE;IACpE,MAAM,IAAI,GACR,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,YAAY,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC,CAAC,YAAY,CAAA;IAEpE,MAAM,MAAM,GAAG,CAAC,CAAA;IAChB,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACpC,OAAO,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAA;AACrC,CAAC,CAAA","sourcesContent":["import { getUser } from '@vltpkg/git'\nimport { PackageJson } from '@vltpkg/package-json'\nimport type { JSONObj } from '@vltpkg/registry-client'\nimport type { NormalizedManifest } from '@vltpkg/types'\nimport { basename, resolve } from 'node:path'\nimport { getAuthorFromGitUser } from './get-author-from-git-user.ts'\nimport { asError, normalizeManifest } from '@vltpkg/types'\nexport { getAuthorFromGitUser }\n\n// eslint-disable-next-line no-console\nconst stderr: (...a: unknown[]) => void = console.error\n\nexport type InitOptions = {\n  cwd?: string\n  author?: string\n  logger?: (...a: unknown[]) => void\n}\n\nexport type CustomizableInitOptions = {\n  name: string\n  author: string\n}\n\nconst template = ({ name, author }: CustomizableInitOptions) =>\n  normalizeManifest({\n    name,\n    version: '1.0.0',\n    description: '',\n    main: 'index.js',\n    ...(author ? { author } : undefined),\n  })\n\nexport type JSONFileInfo<T extends JSONObj = JSONObj> = {\n  path: string\n  data: T\n}\n\nexport type InitFileResults = {\n  manifest?: JSONFileInfo<NormalizedManifest>\n  // TODO: enable these if/when we do more than just the manifest\n  // Eg:\n  // workspaces?: JSONFileInfo\n  // config?: JSONFileInfo\n}\n\nexport const init = async ({\n  cwd = process.cwd(),\n  author,\n  logger = stderr,\n}: InitOptions = {}): Promise<InitFileResults> => {\n  const packageJson = new PackageJson()\n  const path = resolve(cwd, 'package.json')\n  let existingData: NormalizedManifest | undefined\n\n  try {\n    existingData = packageJson.read(cwd)\n    logger('package.json already exists')\n  } catch (err) {\n    if (asError(err).message !== 'Could not read package.json file') {\n      throw err\n    }\n  }\n\n  const name = basename(cwd)\n  const templateData = template({\n    name,\n    author:\n      author ??\n      getAuthorFromGitUser(await getUser().catch(() => undefined)),\n  })\n\n  // Merge template with existing data, preserving existing properties\n  const data: NormalizedManifest =\n    existingData ? { ...templateData, ...existingData } : templateData\n\n  const indent = 2\n  packageJson.write(cwd, data, indent)\n  return { manifest: { path, data } }\n}\n"]}

package/dist/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}