screw-up 1.8.0 → 1.10.0

package/README.md

@@ -70,7 +70,13 @@ my-awesome-library-2.1.0.tgz
 
 ## Documentation
 
-[See the repository](https://github.com/kekyo/screw-up/)
+[See the repository document](https://github.com/kekyo/screw-up/).
+
+## Discussions and Pull Requests
+
+For discussions, please refer to the [GitHub Discussions page](https://github.com/kekyo/screw-up/discussions). We have currently stopped issue-based discussions.
+
+Pull requests are welcome! Please submit them as diffs against the `develop` branch and squashed changes before send.
 
 ## License
 

package/dist/analyzer.d.ts

@@ -1,11 +1,11 @@
 /*!
  * name: screw-up
- * version: 1.8.0
+ * version: 1.10.0
  * description: Simply package metadata inserter on Vite plugin
  * author: Kouji Matsui (@kekyo@mi.kekyo.net)
  * license: MIT
  * repository.url: https://github.com/kekyo/screw-up.git
- * git.commit.hash: da96533e5128033ff7a45d59b1cee39e0e819533
+ * git.commit.hash: ed5f57c0933fcc061c70daf43aae0b41cecf358c
  */
 
 import { Logger } from './internal.js';

package/dist/cli-internal.d.ts

@@ -1,11 +1,11 @@
 /*!
  * name: screw-up
- * version: 1.8.0
+ * version: 1.10.0
  * description: Simply package metadata inserter on Vite plugin
  * author: Kouji Matsui (@kekyo@mi.kekyo.net)
  * license: MIT
  * repository.url: https://github.com/kekyo/screw-up.git
- * git.commit.hash: da96533e5128033ff7a45d59b1cee39e0e819533
+ * git.commit.hash: ed5f57c0933fcc061c70daf43aae0b41cecf358c
  */
 
 import { Logger } from './internal';

package/dist/cli.d.ts

@@ -1,11 +1,11 @@
 /*!
  * name: screw-up
- * version: 1.8.0
+ * version: 1.10.0
  * description: Simply package metadata inserter on Vite plugin
  * author: Kouji Matsui (@kekyo@mi.kekyo.net)
  * license: MIT
  * repository.url: https://github.com/kekyo/screw-up.git
- * git.commit.hash: da96533e5128033ff7a45d59b1cee39e0e819533
+ * git.commit.hash: ed5f57c0933fcc061c70daf43aae0b41cecf358c
  */
 
 import { Logger } from './internal';

package/dist/fast-tags.d.ts

@@ -1,11 +1,11 @@
 /*!
  * name: screw-up
- * version: 1.8.0
+ * version: 1.10.0
  * description: Simply package metadata inserter on Vite plugin
  * author: Kouji Matsui (@kekyo@mi.kekyo.net)
  * license: MIT
  * repository.url: https://github.com/kekyo/screw-up.git
- * git.commit.hash: da96533e5128033ff7a45d59b1cee39e0e819533
+ * git.commit.hash: ed5f57c0933fcc061c70daf43aae0b41cecf358c
  */
 
 import { Logger } from './internal.js';

package/dist/generated/packageMetadata.d.ts

@@ -1,18 +1,18 @@
 /*!
  * name: screw-up
- * version: 1.8.0
+ * version: 1.10.0
  * description: Simply package metadata inserter on Vite plugin
  * author: Kouji Matsui (@kekyo@mi.kekyo.net)
  * license: MIT
  * repository.url: https://github.com/kekyo/screw-up.git
- * git.commit.hash: da96533e5128033ff7a45d59b1cee39e0e819533
+ * git.commit.hash: ed5f57c0933fcc061c70daf43aae0b41cecf358c
  */
 
 export declare const name = "screw-up";
-export declare const version = "1.8.0";
+export declare const version = "1.10.0";
 export declare const description = "Simply package metadata inserter on Vite plugin";
 export declare const author = "Kouji Matsui (@kekyo@mi.kekyo.net)";
 export declare const license = "MIT";
 export declare const repository_url = "https://github.com/kekyo/screw-up.git";
-export declare const git_commit_hash = "da96533e5128033ff7a45d59b1cee39e0e819533";
+export declare const git_commit_hash = "ed5f57c0933fcc061c70daf43aae0b41cecf358c";
 //# sourceMappingURL=packageMetadata.d.ts.map

package/dist/generated/packageMetadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageMetadata.d.ts","sourceRoot":"","sources":["../../src/generated/packageMetadata.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,IAAI,aAAa,CAAC;AAC/B,eAAO,MAAM,OAAO,UAAU,CAAC;AAC/B,eAAO,MAAM,WAAW,oDAAoD,CAAC;AAC7E,eAAO,MAAM,MAAM,uCAAuC,CAAC;AAC3D,eAAO,MAAM,OAAO,QAAQ,CAAC;AAC7B,eAAO,MAAM,cAAc,0CAA0C,CAAC;AACtE,eAAO,MAAM,eAAe,6CAA6C,CAAC"}
+{"version":3,"file":"packageMetadata.d.ts","sourceRoot":"","sources":["../../src/generated/packageMetadata.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,IAAI,aAAa,CAAC;AAC/B,eAAO,MAAM,OAAO,WAAW,CAAC;AAChC,eAAO,MAAM,WAAW,oDAAoD,CAAC;AAC7E,eAAO,MAAM,MAAM,uCAAuC,CAAC;AAC3D,eAAO,MAAM,OAAO,QAAQ,CAAC;AAC7B,eAAO,MAAM,cAAc,0CAA0C,CAAC;AACtE,eAAO,MAAM,eAAe,6CAA6C,CAAC"}

package/dist/git-operations.d.ts

@@ -1,11 +1,11 @@
 /*!
  * name: screw-up
- * version: 1.8.0
+ * version: 1.10.0
  * description: Simply package metadata inserter on Vite plugin
  * author: Kouji Matsui (@kekyo@mi.kekyo.net)
  * license: MIT
  * repository.url: https://github.com/kekyo/screw-up.git
- * git.commit.hash: da96533e5128033ff7a45d59b1cee39e0e819533
+ * git.commit.hash: ed5f57c0933fcc061c70daf43aae0b41cecf358c
  */
 
 import { TagInfo, Version } from './analyzer';

package/dist/index.cjs

@@ -1,17 +1,17 @@
 /*!
  * name: screw-up
- * version: 1.8.0
+ * version: 1.10.0
  * description: Simply package metadata inserter on Vite plugin
  * author: Kouji Matsui (@kekyo@mi.kekyo.net)
  * license: MIT
  * repository.url: https://github.com/kekyo/screw-up.git
- * git.commit.hash: da96533e5128033ff7a45d59b1cee39e0e819533
+ * git.commit.hash: ed5f57c0933fcc061c70daf43aae0b41cecf358c
  */
 "use strict";
 const fs = require("fs/promises");
 const fs$1 = require("fs");
 const path = require("path");
-const packageMetadata = require("./packageMetadata-BwTlrgAe.cjs");
+const packageMetadata = require("./packageMetadata-DUEevWzF.cjs");
 /*!
  * name: async-primitives
  * version: 1.2.0
@@ -203,8 +203,10 @@ const insertBannerHeader = (content, banner) => {
 const sanitizeKey = (key) => {
   return key.replace(/[^a-zA-Z0-9_]/g, "_").replace(/^(\d)/, "_$1");
 };
-const generateMetadataFile = (metadata, outputKeys) => {
+const generateMetadataFileContent = (metadata, outputKeys) => {
   const lines = [];
+  const exportedIdentifiers = [];
+  lines.push("// @ts-nocheck");
   lines.push("// This file is auto-generated by screw-up plugin");
   lines.push("// Do not edit manually");
   lines.push("");
@@ -214,12 +216,13 @@ const generateMetadataFile = (metadata, outputKeys) => {
       const sanitizedKey = sanitizeKey(key);
       const escapedValue = JSON.stringify(value);
       lines.push(`export const ${sanitizedKey} = ${escapedValue};`);
+      exportedIdentifiers.push(sanitizedKey);
     }
   }
   lines.push("");
-  return lines.join("\n");
+  return { content: lines.join("\n"), exportedIdentifiers };
 };
-const generateMetadataTypeFile = (outputKeys) => {
+const generateMetadataTypeFileContent = (outputKeys) => {
   const lines = [];
   lines.push("// This file is auto-generated by screw-up plugin");
   lines.push("// Do not edit manually");
@@ -260,7 +263,7 @@ const screwUp = (options = {}) => {
     insertMetadataBanner = true
   } = options;
   const assetFiltersRegex = assetFilters.map((filter) => new RegExp(filter));
-  const resolvedOutputMetadataFileTypePath = outputMetadataFileTypePath || outputMetadataFilePath.replace(/\.ts$/, ".d.ts");
+  const resolvedOutputMetadataTypeFilePath = outputMetadataFileTypePath || outputMetadataFilePath.replace(/\.ts$/, ".d.ts");
   const generateMetadataSourceLocker = createMutex();
   const loggerPrefix = `${packageMetadata.name}-vite`;
   let logger = packageMetadata.createConsoleLogger(loggerPrefix);
@@ -291,7 +294,28 @@ const screwUp = (options = {}) => {
       return false;
     }
   };
-  const generateMetadataSourceFile = async () => {
+  const ensureMetadataGitignore = async (metadataSourcePath) => {
+    const metadataDirectory = path.dirname(metadataSourcePath);
+    const gitignorePath = path.join(metadataDirectory, ".gitignore");
+    if (fs$1.existsSync(gitignorePath)) {
+      return false;
+    }
+    try {
+      await fs.mkdir(metadataDirectory, { recursive: true });
+      const metadataFileName = path.basename(metadataSourcePath);
+      const gitignoreContent = `# Auto-generated by screw-up plugin
+${metadataFileName}
+`;
+      await fs.writeFile(gitignorePath, gitignoreContent);
+      return true;
+    } catch (error) {
+      logger.warn(
+        `Failed to write .gitignore for metadata source: ${gitignorePath}: ${error}`
+      );
+      return false;
+    }
+  };
+  const generateMetadataSourceFiles = async () => {
     const result = await packageMetadata.resolvePackageMetadata(
       projectRoot,
       fetchGitMetadata,
@@ -301,25 +325,49 @@ const screwUp = (options = {}) => {
     metadata = result.metadata;
     banner = generateBanner(metadata, outputKeys);
     if (outputMetadataFile) {
-      const metadataSourceContent = generateMetadataFile(
-        metadata,
-        outputMetadataKeys
-      );
+      const { content: metadataSourceContent, exportedIdentifiers } = generateMetadataFileContent(metadata, outputMetadataKeys);
       const metadataSourcePath = path.join(projectRoot, outputMetadataFilePath);
-      return await writeFileIfChanged(
+      const metadataWritten = await writeFileIfChanged(
         metadataSourcePath,
         metadataSourceContent,
         "metadata source file"
       );
+      const metadataTypeContent = generateMetadataTypeFileContent(exportedIdentifiers);
+      const metadataTypePath = path.join(
+        projectRoot,
+        resolvedOutputMetadataTypeFilePath
+      );
+      const metadataTypeWritten = await writeFileIfChanged(
+        metadataTypePath,
+        metadataTypeContent,
+        "metadata type definition file"
+      );
+      if (fs$1.existsSync(metadataSourcePath)) {
+        const gitignoreWritten = await ensureMetadataGitignore(metadataSourcePath);
+        if (gitignoreWritten) {
+          logger.info(
+            `generateMetadataSourceFile: .gitignore is generated: ${path.join(
+              path.dirname(outputMetadataFilePath),
+              ".gitignore"
+            )}`
+          );
+        }
+      }
+      if (metadataTypeWritten) {
+        logger.info(
+          `generateMetadataSourceFile: Metadata type definition file is generated: ${resolvedOutputMetadataTypeFilePath}`
+        );
+      }
+      return metadataWritten || metadataTypeWritten;
     }
     return false;
   };
-  const generateMetadataTypeDefinitionFile = async () => {
+  const generateMetadataTypeDefinitionFileFromKeys = async (keys) => {
     if (outputMetadataFile) {
-      const metadataTypeContent = generateMetadataTypeFile(outputMetadataKeys);
+      const metadataTypeContent = generateMetadataTypeFileContent(keys);
       const metadataTypePath = path.join(
         projectRoot,
-        resolvedOutputMetadataFileTypePath
+        resolvedOutputMetadataTypeFilePath
       );
       return await writeFileIfChanged(
         metadataTypePath,
@@ -329,17 +377,17 @@ const screwUp = (options = {}) => {
     }
     return false;
   };
-  const generateDummyMetadataFile = async () => {
+  const generateMetadataFileFromKeys = async (keys) => {
     if (outputMetadataFile) {
       const metadataSourcePath = path.join(projectRoot, outputMetadataFilePath);
       if (!fs$1.existsSync(metadataSourcePath)) {
         const dummyMetadata = {};
-        outputMetadataKeys.forEach((key) => {
+        keys.forEach((key) => {
           dummyMetadata[key] = "[Require first build]";
         });
-        const dummyContent = generateMetadataFile(
+        const { content: dummyContent } = generateMetadataFileContent(
           dummyMetadata,
-          outputMetadataKeys
+          keys
         );
         return await writeFileIfChanged(
           metadataSourcePath,
@@ -359,12 +407,12 @@ const screwUp = (options = {}) => {
     applyToEnvironment: async (penv) => {
       logger.info(`${packageMetadata.version}-${packageMetadata.git_commit_hash}: Started.`);
       projectRoot = penv.config.root;
-      if (projectRoot && await generateMetadataTypeDefinitionFile()) {
+      if (projectRoot && await generateMetadataTypeDefinitionFileFromKeys(outputMetadataKeys)) {
         logger.info(
-          `applyToEnvironment: Metadata type definition file is generated: ${resolvedOutputMetadataFileTypePath}`
+          `applyToEnvironment: Metadata type definition file is generated: ${resolvedOutputMetadataTypeFilePath}`
         );
       }
-      if (projectRoot && await generateDummyMetadataFile()) {
+      if (projectRoot && await generateMetadataFileFromKeys(outputMetadataKeys)) {
         logger.info(
           `applyToEnvironment: Dummy metadata source file is generated: ${outputMetadataFilePath}`
         );
@@ -386,7 +434,7 @@ const screwUp = (options = {}) => {
           checkWorkingDirectoryStatus,
           logger
         );
-        if (await generateMetadataSourceFile()) {
+        if (await generateMetadataSourceFiles()) {
           logger.info(
             `configResolved: Metadata source file is generated: ${outputMetadataFilePath}`
           );
@@ -408,7 +456,7 @@ const screwUp = (options = {}) => {
             `configureServer: Excluded from watcher: ${outputMetadataFilePath}`
           );
         }
-        if (await generateMetadataSourceFile()) {
+        if (await generateMetadataSourceFiles()) {
           logger.info(
             `configureServer: Metadata source file is generated: ${outputMetadataFilePath}`
           );
@@ -423,7 +471,7 @@ const screwUp = (options = {}) => {
       const l = await generateMetadataSourceLocker.lock();
       try {
         logger.debug(`buildStart: Started.`);
-        if (await generateMetadataSourceFile()) {
+        if (await generateMetadataSourceFiles()) {
           logger.info(
             `buildStart: Metadata source file is generated: ${outputMetadataFilePath}`
           );