screw-up 1.17.0 → 1.18.0

package/README.md

@@ -49,6 +49,10 @@ To insert banner header each bundled source files (`dist/index.js` and etc.):
 You may have noticed the line `git.commit.hash:`. That's right, if your project is managed by Git (it is, right?), you can also insert commit IDs, branch information, and tag information.
 Most importantly, if a version is applied to a Git tag, you can automatically reflect that version tag in the `version` field of `package.json`. In other words, you can manage version numbers using only Git tags!
 
+This calculates the version number by measuring the commit height to the current HEAD based on the last applied version tag.
+
+![git-versioning](./images/git-versioning.png)
+
 Instead of using `npm pack`, you can use the CLI tool `screw-up` to generate packages, which will automatically apply the collected metadata to the NPM package's `package.json`:
 
 ```bash

package/dist/analyzer.d.ts

@@ -1,11 +1,11 @@
 /*!
  * name: screw-up
- * version: 1.17.0
+ * version: 1.18.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: 05a9f2e0dec5249126f020eee1d57f6ff8767096
+ * git.commit.hash: 104b6e6ab47e8c328ae5d6883f7931b0eea4f5cd
  */
 
 import { Logger } from './internal.js';

package/dist/cli-internal.d.ts

@@ -1,11 +1,11 @@
 /*!
  * name: screw-up
- * version: 1.17.0
+ * version: 1.18.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: 05a9f2e0dec5249126f020eee1d57f6ff8767096
+ * git.commit.hash: 104b6e6ab47e8c328ae5d6883f7931b0eea4f5cd
  */
 
 import { Logger } from './internal';

package/dist/cli.d.ts

@@ -1,11 +1,11 @@
 /*!
  * name: screw-up
- * version: 1.17.0
+ * version: 1.18.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: 05a9f2e0dec5249126f020eee1d57f6ff8767096
+ * git.commit.hash: 104b6e6ab47e8c328ae5d6883f7931b0eea4f5cd
  */
 
 import { Logger } from './internal';

package/dist/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;;;;AAiBA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAypBpC,eAAO,MAAM,OAAO,GAClB,MAAM,MAAM,EAAE,EACd,QAAQ,MAAM,KACb,OAAO,CAAC,MAAM,CA8BhB,CAAC"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;;;;AAiBA,OAAO,EAAE,MAAM,EAA0B,MAAM,YAAY,CAAC;AAkyB5D,eAAO,MAAM,OAAO,GAClB,MAAM,MAAM,EAAE,EACd,QAAQ,MAAM,KACb,OAAO,CAAC,MAAM,CAgChB,CAAC"}

package/dist/fast-tags.d.ts

@@ -1,11 +1,11 @@
 /*!
  * name: screw-up
- * version: 1.17.0
+ * version: 1.18.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: 05a9f2e0dec5249126f020eee1d57f6ff8767096
+ * git.commit.hash: 104b6e6ab47e8c328ae5d6883f7931b0eea4f5cd
  */
 
 import { Logger } from './internal.js';

package/dist/generated/packageMetadata.d.ts

@@ -1,18 +1,18 @@
 /*!
  * name: screw-up
- * version: 1.17.0
+ * version: 1.18.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: 05a9f2e0dec5249126f020eee1d57f6ff8767096
+ * git.commit.hash: 104b6e6ab47e8c328ae5d6883f7931b0eea4f5cd
  */
 
 export declare const name = "screw-up";
-export declare const version = "1.17.0";
+export declare const version = "1.18.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 = "05a9f2e0dec5249126f020eee1d57f6ff8767096";
+export declare const git_commit_hash = "104b6e6ab47e8c328ae5d6883f7931b0eea4f5cd";
 //# sourceMappingURL=packageMetadata.d.ts.map

package/dist/git-operations.d.ts

@@ -1,11 +1,11 @@
 /*!
  * name: screw-up
- * version: 1.17.0
+ * version: 1.18.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: 05a9f2e0dec5249126f020eee1d57f6ff8767096
+ * git.commit.hash: 104b6e6ab47e8c328ae5d6883f7931b0eea4f5cd
  */
 
 import { TagInfo, Version } from './analyzer';

package/dist/index.cjs

@@ -1,17 +1,17 @@
 "use strict";
 /*!
  * name: screw-up
- * version: 1.17.0
+ * version: 1.18.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: 05a9f2e0dec5249126f020eee1d57f6ff8767096
+ * git.commit.hash: 104b6e6ab47e8c328ae5d6883f7931b0eea4f5cd
  */
 const fs = require("fs/promises");
 const fs$1 = require("fs");
 const path = require("path");
-const packageMetadata = require("./packageMetadata-DdvLnmBC.cjs");
+const packageMetadata = require("./packageMetadata-B-eWBZ6y.cjs");
 /*!
  * name: async-primitives
  * version: 1.2.0
@@ -227,40 +227,6 @@ const mergeBanners = (currentBanner, existingBanner) => {
   const currentWithNewline = ensureTrailingNewline(currentBanner, newlineSeq);
   return `${currentWithNewline}${existingBanner}`;
 };
-const sanitizeKey = (key) => {
-  return key.replace(/[^a-zA-Z0-9_]/g, "_").replace(/^(\d)/, "_$1");
-};
-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("");
-  for (const key of outputKeys) {
-    const value = metadata[key];
-    if (value) {
-      const sanitizedKey = sanitizeKey(key);
-      const escapedValue = JSON.stringify(value);
-      lines.push(`export const ${sanitizedKey} = ${escapedValue};`);
-      exportedIdentifiers.push(sanitizedKey);
-    }
-  }
-  lines.push("");
-  return { content: lines.join("\n"), exportedIdentifiers };
-};
-const generateMetadataTypeFileContent = (outputKeys) => {
-  const lines = [];
-  lines.push("// This file is auto-generated by screw-up plugin");
-  lines.push("// Do not edit manually");
-  lines.push("");
-  for (const key of outputKeys) {
-    const sanitizedKey = sanitizeKey(key);
-    lines.push(`export declare const ${sanitizedKey}: string;`);
-  }
-  lines.push("");
-  return lines.join("\n");
-};
 const countInsertedLines = (bannerWithTrailingNewline) => {
   return bannerWithTrailingNewline.split("\n").length - 1;
 };
@@ -302,7 +268,6 @@ const screwUp = (options = {}) => {
     assetFilters = ["\\.d\\.ts$"],
     outputMetadataFile = false,
     outputMetadataFilePath = "src/generated/packageMetadata.ts",
-    outputMetadataFileTypePath,
     outputMetadataKeys = [
       "name",
       "version",
@@ -317,7 +282,6 @@ const screwUp = (options = {}) => {
     insertMetadataBanner = true
   } = options;
   const assetFiltersRegex = assetFilters.map((filter) => new RegExp(filter));
-  const resolvedOutputMetadataTypeFilePath = outputMetadataFileTypePath || outputMetadataFilePath.replace(/\.ts$/, ".d.ts");
   const generateMetadataSourceLocker = createMutex();
   const loggerPrefix = `${packageMetadata.name}-vite`;
   let logger = packageMetadata.createConsoleLogger(loggerPrefix);
@@ -325,50 +289,6 @@ const screwUp = (options = {}) => {
   let metadata;
   let projectRoot;
   let fetchGitMetadata = () => Promise.resolve({});
-  const writeFileIfChanged = async (filePath, content, description) => {
-    try {
-      let shouldWrite = !fs$1.existsSync(filePath);
-      if (!shouldWrite) {
-        try {
-          const existingContent = await fs.readFile(filePath, "utf-8");
-          shouldWrite = existingContent !== content;
-        } catch (e) {
-          shouldWrite = true;
-        }
-      }
-      if (shouldWrite) {
-        await fs.mkdir(path.dirname(filePath), { recursive: true });
-        await fs.writeFile(filePath, content);
-        return true;
-      } else {
-        return false;
-      }
-    } catch (error) {
-      logger.warn(`Failed to write ${description}: ${filePath}: ${error}`);
-      return false;
-    }
-  };
-  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,
@@ -379,25 +299,22 @@ ${metadataFileName}
     metadata = result.metadata;
     banner = generateBanner(metadata, outputKeys);
     if (outputMetadataFile) {
-      const { content: metadataSourceContent, exportedIdentifiers } = generateMetadataFileContent(metadata, outputMetadataKeys);
+      const metadataSourceContent = packageMetadata.generateMetadataFileContent(
+        metadata,
+        outputMetadataKeys
+      );
       const metadataSourcePath = path.join(projectRoot, outputMetadataFilePath);
-      const metadataWritten = await writeFileIfChanged(
+      const metadataWritten = await packageMetadata.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"
+        "metadata source file",
+        logger
       );
       if (fs$1.existsSync(metadataSourcePath)) {
-        const gitignoreWritten = await ensureMetadataGitignore(metadataSourcePath);
+        const gitignoreWritten = await packageMetadata.ensureMetadataGitignore(
+          metadataSourcePath,
+          logger
+        );
         if (gitignoreWritten) {
           logger.info(
             `generateMetadataSourceFile: .gitignore is generated: ${path.join(
@@ -407,27 +324,7 @@ ${metadataFileName}
           );
         }
       }
-      if (metadataTypeWritten) {
-        logger.info(
-          `generateMetadataSourceFile: Metadata type definition file is generated: ${resolvedOutputMetadataTypeFilePath}`
-        );
-      }
-      return metadataWritten || metadataTypeWritten;
-    }
-    return false;
-  };
-  const generateMetadataTypeDefinitionFileFromKeys = async (keys) => {
-    if (outputMetadataFile) {
-      const metadataTypeContent = generateMetadataTypeFileContent(keys);
-      const metadataTypePath = path.join(
-        projectRoot,
-        resolvedOutputMetadataTypeFilePath
-      );
-      return await writeFileIfChanged(
-        metadataTypePath,
-        metadataTypeContent,
-        "metadata type definition file"
-      );
+      return metadataWritten;
     }
     return false;
   };
@@ -439,14 +336,12 @@ ${metadataFileName}
         keys.forEach((key) => {
           dummyMetadata[key] = "[Require first build]";
         });
-        const { content: dummyContent } = generateMetadataFileContent(
-          dummyMetadata,
-          keys
-        );
-        return await writeFileIfChanged(
+        const dummyContent = packageMetadata.generateMetadataFileContent(dummyMetadata, keys);
+        return await packageMetadata.writeFileIfChanged(
           metadataSourcePath,
           dummyContent,
-          "dummy metadata source file"
+          "dummy metadata source file",
+          logger
         );
       }
     }
@@ -461,11 +356,6 @@ ${metadataFileName}
     applyToEnvironment: async (penv) => {
       logger.info(`${packageMetadata.version}-${packageMetadata.git_commit_hash}: Started.`);
       projectRoot = penv.config.root;
-      if (projectRoot && await generateMetadataTypeDefinitionFileFromKeys(outputMetadataKeys)) {
-        logger.info(
-          `applyToEnvironment: Metadata type definition file is generated: ${resolvedOutputMetadataTypeFilePath}`
-        );
-      }
       if (projectRoot && await generateMetadataFileFromKeys(outputMetadataKeys)) {
         logger.info(
           `applyToEnvironment: Dummy metadata source file is generated: ${outputMetadataFilePath}`