@vltpkg/init 0.0.0-3 → 0.0.0-31

package/README.md

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

package/dist/esm/index.d.ts

@@ -1,5 +1,5 @@
 import type { JSONObj } from '@vltpkg/registry-client';
-import type { Manifest } from '@vltpkg/types';
+import type { NormalizedManifest } from '@vltpkg/types';
 import { getAuthorFromGitUser } from './get-author-from-git-user.ts';
 export { getAuthorFromGitUser };
 export type InitOptions = {
@@ -16,7 +16,7 @@ export type JSONFileInfo<T extends JSONObj = JSONObj> = {
     data: T;
 };
 export type InitFileResults = {
-    manifest?: JSONFileInfo<Manifest>;
+    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 +1 @@
-{"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,QAAQ,EAAE,MAAM,eAAe,CAAA;AAE7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAA;AACpE,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;AAaD,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,QAAQ,CAAC,CAAA;CAKlC,CAAA;AAED,eAAO,MAAM,IAAI,8BAId,WAAW,KAAQ,OAAO,CAAC,eAAe,CAyB5C,CAAA"}
+{"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

@@ -2,10 +2,11 @@ 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, }) => ({
+const template = ({ name, author }) => normalizeManifest({
     name,
     version: '1.0.0',
     description: '',
@@ -15,26 +16,26 @@ const template = ({ name, author, }) => ({
 export const init = async ({ cwd = process.cwd(), author, logger = stderr, } = {}) => {
     const packageJson = new PackageJson();
     const path = resolve(cwd, 'package.json');
+    let existingData;
     try {
-        packageJson.read(cwd);
-        // will only return here in case the package.json file does not exist
+        existingData = packageJson.read(cwd);
         logger('package.json already exists');
-        return {};
     }
-    catch (e) {
-        const err = e;
-        if (!!e && err.message !== 'Could not read package.json file') {
+    catch (err) {
+        if (asError(err).message !== 'Could not read package.json file') {
             throw err;
         }
-        const name = basename(cwd);
-        const data = template({
-            name,
-            author: author ??
-                getAuthorFromGitUser(await getUser().catch(() => undefined)),
-        });
-        const indent = 2;
-        packageJson.write(cwd, data, indent);
-        return { manifest: { path, data } };
     }
+    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 +1 @@
-{"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,oBAAoB,EAAE,CAAA;AAE/B,sCAAsC;AACtC,MAAM,MAAM,GAA8B,OAAO,CAAC,KAAK,CAAA;AAavD,MAAM,QAAQ,GAAG,CAAC,EAChB,IAAI,EACJ,MAAM,GACkB,EAAY,EAAE,CAAC,CAAC;IACxC,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;AAeF,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,CAAC;QACH,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACrB,qEAAqE;QACrE,MAAM,CAAC,6BAA6B,CAAC,CAAA;QACrC,OAAO,EAAE,CAAA;IACX,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,GAAG,GAAG,CAAU,CAAA;QACtB,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,OAAO,KAAK,kCAAkC,EAAE,CAAC;YAC9D,MAAM,GAAG,CAAA;QACX,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;QAC1B,MAAM,IAAI,GAAG,QAAQ,CAAC;YACpB,IAAI;YACJ,MAAM,EACJ,MAAM;gBACN,oBAAoB,CAAC,MAAM,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;SAC/D,CAAC,CAAA;QACF,MAAM,MAAM,GAAG,CAAC,CAAA;QAChB,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QACpC,OAAO,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAA;IACrC,CAAC;AACH,CAAC,CAAA","sourcesContent":["import { getUser } from '@vltpkg/git'\nimport { PackageJson } from '@vltpkg/package-json'\nimport type { JSONObj } from '@vltpkg/registry-client'\nimport type { Manifest } from '@vltpkg/types'\nimport { basename, resolve } from 'node:path'\nimport { getAuthorFromGitUser } from './get-author-from-git-user.ts'\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 = ({\n  name,\n  author,\n}: CustomizableInitOptions): Manifest => ({\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<Manifest>\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  try {\n    packageJson.read(cwd)\n    // will only return here in case the package.json file does not exist\n    logger('package.json already exists')\n    return {}\n  } catch (e) {\n    const err = e as Error\n    if (!!e && err.message !== 'Could not read package.json file') {\n      throw err\n    }\n\n    const name = basename(cwd)\n    const data = template({\n      name,\n      author:\n        author ??\n        getAuthorFromGitUser(await getUser().catch(() => undefined)),\n    })\n    const indent = 2\n    packageJson.write(cwd, data, indent)\n    return { manifest: { path, data } }\n  }\n}\n"]}
+{"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/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@vltpkg/init",
   "description": "vlt project intialization logic",
-  "version": "0.0.0-3",
+  "version": "0.0.0-31",
   "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,
@@ -19,24 +20,21 @@
     }
   },
   "dependencies": {
-    "@vltpkg/error-cause": "0.0.0-3",
-    "@vltpkg/git": "0.0.0-3",
-    "@vltpkg/package-json": "0.0.0-3",
-    "@vltpkg/xdg": "0.0.0-3",
-    "@vltpkg/registry-client": "0.0.0-3",
-    "@vltpkg/types": "0.0.0-3"
+    "@vltpkg/package-json": "0.0.0-31",
+    "@vltpkg/git": "0.0.0-31",
+    "@vltpkg/registry-client": "0.0.0-31",
+    "@vltpkg/types": "0.0.0-31"
   },
   "devDependencies": {
-    "@eslint/js": "^9.20.0",
-    "@types/eslint__js": "^8.42.3",
-    "@types/node": "^22.13.1",
-    "eslint": "^9.20.0",
-    "prettier": "^3.4.2",
+    "@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",
-    "typedoc": "0.27.6",
+    "typedoc": "~0.27.9",
     "typescript": "5.7.3",
-    "typescript-eslint": "^8.23.0"
+    "typescript-eslint": "^8.40.0"
   },
   "license": "BSD-2-Clause-Patent",
   "engines": {
@@ -68,6 +66,7 @@
     "snap": "tap",
     "test": "tap",
     "posttest": "tsc --noEmit",
+    "tshy": "tshy",
     "typecheck": "tsc --noEmit"
   }
 }