@vltpkg/init 0.0.0-10

package/LICENSE

@@ -0,0 +1,15 @@
+Copyright (c) vlt technology, Inc.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+   Subject to the terms and conditions of this license, each copyright holder and contributor hereby grants to those receiving rights under this license a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except for failure to satisfy the conditions of this license) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer this software, where such license applies only to those patent claims, already acquired or hereafter acquired, licensable by such copyright holder or contributor that are necessarily infringed by:
+
+(a) their Contribution(s) (the licensed copyrights of copyright holders and non-copyrightable additions of contributors, in source or binary form) alone; or
+(b) combination of their Contribution(s) with the work of authorship to which such Contribution(s) was added by such copyright holder or contributor, if, at the time the Contribution is added, such addition causes such combination to be necessarily infringed. The patent license shall not apply to any other combinations which include the Contribution.
+Except as expressly stated above, no rights or licenses from any copyright holder or contributor is granted under this license, whether expressly, by implication, estoppel or otherwise.
+
+DISCLAIMER
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,21 @@
+# @vltpkg/init
+
+Project initialization logic for `vlt`.
+
+**[Usage](#usage)**
+
+## Overview
+
+This is a tool that provides the project initialization logic used by
+the vlt cli and gui.
+
+## Usage
+
+```js
+import { init } from '@vltpkg/init'
+
+// initalize a project
+const results = await init({ cwd: '/some/path' })
+
+// now results contains { manifest: { path, data }}
+```

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

@@ -0,0 +1,3 @@
+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.d.ts.map

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,15 @@
+export const getAuthorFromGitUser = (user) => {
+    if (!user)
+        return '';
+    const { name, email } = user;
+    let res = '';
+    if (name)
+        res += name;
+    if (email) {
+        if (name)
+            res += ' ';
+        res += `<${email}>`;
+    }
+    return res;
+};
+//# sourceMappingURL=get-author-from-git-user.js.map

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,22 @@
+import type { JSONObj } from '@vltpkg/registry-client';
+import type { Manifest } 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<Manifest>;
+};
+export declare const init: ({ cwd, author, logger, }?: InitOptions) => Promise<InitFileResults>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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;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;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,CAwB5C,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,40 @@
+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 } from '@vltpkg/error-cause';
+export { getAuthorFromGitUser };
+// eslint-disable-next-line no-console
+const stderr = console.error;
+const template = ({ name, author, }) => ({
+    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');
+    try {
+        packageJson.read(cwd);
+        // will only return here in case the package.json file does not exist
+        logger('package.json already exists');
+        return {};
+    }
+    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 } };
+    }
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +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,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAC7C,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,GAAG,EAAE,CAAC;QACb,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,KAAK,kCAAkC,EAAE,CAAC;YAChE,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'\nimport { asError } from '@vltpkg/error-cause'\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 (err) {\n    if (asError(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"]}

package/dist/esm/package.json

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

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@vltpkg/init",
+  "description": "vlt project intialization logic",
+  "version": "0.0.0-10",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vltpkg/vltpkg.git",
+    "directory": "src/init"
+  },
+  "tshy": {
+    "selfLink": false,
+    "liveDev": true,
+    "dialects": [
+      "esm"
+    ],
+    "exports": {
+      "./package.json": "./package.json",
+      ".": "./src/index.ts"
+    }
+  },
+  "dependencies": {
+    "@vltpkg/error-cause": "0.0.0-10",
+    "@vltpkg/package-json": "0.0.0-10",
+    "@vltpkg/git": "0.0.0-10",
+    "@vltpkg/registry-client": "0.0.0-10",
+    "@vltpkg/types": "0.0.0-10"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.25.0",
+    "@types/node": "^22.14.1",
+    "eslint": "^9.25.0",
+    "prettier": "^3.5.3",
+    "tap": "^21.1.0",
+    "tshy": "^3.0.2",
+    "typedoc": "~0.27.6",
+    "typescript": "5.7.3",
+    "typescript-eslint": "^8.30.1"
+  },
+  "license": "BSD-2-Clause-Patent",
+  "engines": {
+    "node": ">=22"
+  },
+  "tap": {
+    "extends": "../../tap-config.yaml"
+  },
+  "prettier": "../../.prettierrc.js",
+  "module": "./dist/esm/index.js",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/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",
+    "typecheck": "tsc --noEmit"
+  }
+}