@vltpkg/init 1.0.0-rc.26 → 1.0.0-rc.29

package/dist/index.d.ts

@@ -15,7 +15,17 @@ export type JSONFileInfo<T extends JSONObj = JSONObj> = {
     path: string;
     data: T;
 };
+export type GitignoreFileInfo = {
+    path: string;
+};
 export type InitFileResults = {
     manifest?: JSONFileInfo<NormalizedManifest>;
+    gitignore?: GitignoreFileInfo;
 };
+/**
+ * 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;
 export declare const init: ({ cwd, author, logger, }?: InitOptions) => Promise<InitFileResults>;

package/dist/index.js

@@ -1,5 +1,6 @@
 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';
@@ -13,6 +14,28 @@ const template = ({ name, author }) => normalizeManifest({
     main: 'index.js',
     ...(author ? { author } : undefined),
 });
+const GITIGNORE_ENTRY = 'node_modules';
+/**
+ * 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;
+};
 export const init = async ({ cwd = process.cwd(), author, logger = stderr, } = {}) => {
     const packageJson = new PackageJson();
     const path = resolve(cwd, 'package.json');
@@ -36,5 +59,9 @@ export const init = async ({ cwd = process.cwd(), author, logger = stderr, } = {
     const data = existingData ? { ...templateData, ...existingData } : templateData;
     const indent = 2;
     packageJson.write(cwd, data, indent);
-    return { manifest: { path, data } };
+    const gitignore = ensureGitignore(cwd);
+    return {
+        manifest: { path, data },
+        ...(gitignore ? { gitignore } : {}),
+    };
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vltpkg/init",
   "description": "vlt project intialization logic",
-  "version": "1.0.0-rc.26",
+  "version": "1.0.0-rc.29",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vltpkg/vltpkg.git",
@@ -13,10 +13,10 @@
     "url": "http://vlt.sh"
   },
   "dependencies": {
-    "@vltpkg/git": "1.0.0-rc.26",
-    "@vltpkg/package-json": "1.0.0-rc.26",
-    "@vltpkg/registry-client": "1.0.0-rc.26",
-    "@vltpkg/types": "1.0.0-rc.26"
+    "@vltpkg/git": "1.0.0-rc.29",
+    "@vltpkg/package-json": "1.0.0-rc.29",
+    "@vltpkg/registry-client": "1.0.0-rc.29",
+    "@vltpkg/types": "1.0.0-rc.29"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.1",