scripts[patch]: Ability to add additional gitignore paths to lc config (

#5270)
langchain-ai · May 2, 2024 · 3a79ec0 · 3a79ec0
1 parent 9eede89
commit 3a79ec0
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/libs/langchain-scripts/bin/build b/libs/langchain-scripts/bin/build
@@ -434,6 +434,8 @@ const updateConfig = ({
   requiresOptionalDependency,
   /** @type {boolean} */
   shouldTestExports,
+  /** @type {Array<string> | undefined} */
+  additionalGitignorePaths = [],
 }) => {
   const generatedFiles = generateFiles(entrypoints);
   const filenames = Object.keys(generatedFiles);
@@ -468,10 +470,12 @@ const updateConfig = ({
     fs.writeFileSync(filename, content);
   });
 
+  const gitignorePaths = [...filenames, ...DEFAULT_GITIGNORE_PATHS, ...(additionalGitignorePaths ? additionalGitignorePaths : [])];
+
   // Update .gitignore
   fs.writeFileSync(
     "./.gitignore",
-    `${filenames.join("\n")}\n${DEFAULT_GITIGNORE_PATHS.join("\n")}\n`
+    `${gitignorePaths.join("\n")}\n`
   );
 
   if (shouldTestExports) {
@@ -724,6 +728,11 @@ export function createEntrypoints({
    * @type {boolean}
    */
   shouldGenMaps,
+  /**
+   * Additional paths to add to the .gitignore file.
+   * @type {Array<string> | undefined}
+   */
+  additionalGitignorePaths,
 }) {
   if (isPre) {
     cleanGenerated({ entrypoints });
@@ -753,6 +762,7 @@ export function createEntrypoints({
       deprecatedNodeOnly,
       requiresOptionalDependency,
       shouldTestExports,
+      additionalGitignorePaths,
     });
   }
 }
@@ -850,6 +860,7 @@ async function main() {
       absTsConfigPath: config.tsConfigPath,
       isPre,
       shouldGenMaps,
+      additionalGitignorePaths: config.additionalGitignorePaths,
     });
   }
 

diff --git a/libs/langchain-scripts/package.json b/libs/langchain-scripts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@langchain/scripts",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "Shared scripts for LangChain.js",
   "type": "module",
   "engines": {

diff --git a/libs/langchain-scripts/src/types.ts b/libs/langchain-scripts/src/types.ts
@@ -147,4 +147,10 @@ export interface LangChainConfig {
    * @returns {string}
    */
   abs: (relativePath: string) => string;
+  /**
+   * Additional paths to add to the gitignore file.
+   * @default undefined
+   * @type {string[]}
+   */
+  additionalGitignorePaths?: string[];
 }