semantic-release-pub 0.6.2 → 0.7.0

package/README.md

@@ -3,8 +3,8 @@
 [![npm](https://img.shields.io/npm/v/semantic-release-pub)](https://www.npmjs.com/package/semantic-release-pub)
 [![License](https://img.shields.io/github/license/zeshuaro/semantic-release-pub)](https://github.com/zeshuaro/semantic-release-pub/blob/main/LICENSE)
 [![GitHub Actions](https://github.com/zeshuaro/semantic-release-pub/actions/workflows/github-actions.yml/badge.svg)](https://github.com/zeshuaro/semantic-release-pub/actions/workflows/github-actions.yml)
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=semantic-release-pub&metric=coverage)](https://sonarcloud.io/summary/new_code?id=semantic-release-pub)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=semantic-release-pub&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=semantic-release-pub)
+[![codecov](https://codecov.io/github/zeshuaro/semantic-release-pub/graph/badge.svg?token=P40ZNZNXG2)](https://codecov.io/github/zeshuaro/semantic-release-pub)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/2694cc48a8dd416798eaab232948090a)](https://app.codacy.com/gh/zeshuaro/semantic-release-pub/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Code Style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 
 [![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/zeshuaro)
@@ -92,10 +92,11 @@ The following instructions are referenced from the [documentation](https://dart.
 
 ### Options
 
-| Option       | Description                                                                                                          | Default |
-| ------------ | -------------------------------------------------------------------------------------------------------------------- | ------- |
-| `cli`        | The `dart` or `flutter` CLI to use to publish the package to the registry.                                           | `dart`  |
-| `publishPub` | Whether to publish the package to the registry. If set to `false`, the `pubspec.yaml` version will still be updated. | `true`  |
+| Option              | Description                                                                                                                                                                                                                                             | Default |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| `cli`               | The `dart` or `flutter` CLI to use to publish the package to the registry.                                                                                                                                                                              | `dart`  |
+| `publishPub`        | Whether to publish the package to the registry. If set to `false`, the `pubspec.yaml` version will still be updated.                                                                                                                                    | `true`  |
+| `updateBuildNumber` | Whether to write build number for every newly bumped version in `pubspec.yaml`. Note that the build number will always be increased by one. Learn more on [Flutter docs](https://docs.flutter.dev/deployment/android#updating-the-apps-version-number). | `false` |
 
 ### Examples
 
@@ -115,3 +116,5 @@ The following instructions are referenced from the [documentation](https://dart.
   ]
 }
 ```
+
+See [here](https://github.com/zeshuaro/firestore_cache/pull/162) for a sample pull request utilising this plugin and `semantic-release` to publish a Flutter package.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { verifyConditions } from './verifyConditions.js';
-export { PluginConfig } from './types.js';
-export { prepare } from './prepare.js';
-export { publish } from './publish.js';
+export { verifyConditions } from "./verifyConditions.js";
+export { PluginConfig } from "./types.js";
+export { prepare } from "./prepare.js";
+export { publish } from "./publish.js";

package/dist/index.js

@@ -1,3 +1,3 @@
-export { verifyConditions } from './verifyConditions.js';
-export { prepare } from './prepare.js';
-export { publish } from './publish.js';
+export { verifyConditions } from "./verifyConditions.js";
+export { prepare } from "./prepare.js";
+export { publish } from "./publish.js";

package/dist/prepare.d.ts

@@ -1,3 +1,3 @@
-import { PrepareContext } from 'semantic-release';
-import { PluginConfig } from './types.js';
-export declare const prepare: (_pluginConfig: PluginConfig, { nextRelease: { version }, logger }: PrepareContext) => Promise<void>;
+import { PrepareContext } from "semantic-release";
+import { PluginConfig } from "./types.js";
+export declare const prepare: (pluginConfig: PluginConfig, { nextRelease: { version }, logger }: PrepareContext) => Promise<void>;

package/dist/prepare.js

@@ -1,12 +1,24 @@
-import { readFileSync, writeFileSync } from 'fs';
-import { parse } from 'yaml';
-import { Pubspec } from './schemas.js';
-const PUBSPEC_PATH = 'pubspec.yaml';
-export const prepare = async (_pluginConfig, { nextRelease: { version }, logger }) => {
-    const data = readFileSync(PUBSPEC_PATH, 'utf-8');
+import { readFileSync, writeFileSync } from "fs";
+import { parse } from "yaml";
+import SemanticReleaseError from "@semantic-release/error";
+import { Pubspec } from "./schemas.js";
+import { getConfig } from "./utils.js";
+const PUBSPEC_PATH = "pubspec.yaml";
+export const prepare = async (pluginConfig, { nextRelease: { version }, logger }) => {
+    const { updateBuildNumber } = getConfig(pluginConfig);
+    const data = readFileSync(PUBSPEC_PATH, "utf-8");
     const pubspec = Pubspec.parse(parse(data));
-    const pubspecVersionEscaped = pubspec.version.replace(/[/\-\\^$*+?.()|[\]{}]/g, '\\$&');
-    const newData = data.replace(new RegExp(`version:[ \t]+${pubspecVersionEscaped}`), `version: ${version}`);
-    logger.log(`Writing version ${version} to ${PUBSPEC_PATH}`);
+    const pubspecVersionEscaped = pubspec.version.replace(/[/\-\\^$*+?.()|[\]{}]/g, "\\$&");
+    let nextVersion = version;
+    if (updateBuildNumber) {
+        const parts = pubspec.version.split("+");
+        const buildNumber = parts.length > 1 ? Number(parts[1]) : 0;
+        if (isNaN(buildNumber)) {
+            throw new SemanticReleaseError(`Invalid build number: ${buildNumber} in ${pubspec.version}`);
+        }
+        nextVersion = `${version}+${buildNumber + 1}`;
+    }
+    const newData = data.replace(new RegExp(`version:[ \t]+${pubspecVersionEscaped}`), `version: ${nextVersion}`);
+    logger.log(`Writing version ${nextVersion} to ${PUBSPEC_PATH}`);
     writeFileSync(PUBSPEC_PATH, newData);
 };

package/dist/publish.d.ts

@@ -1,3 +1,3 @@
-import { PublishContext } from 'semantic-release';
-import { PluginConfig } from './types.js';
+import { PublishContext } from "semantic-release";
+import { PluginConfig } from "./types.js";
 export declare const publish: (pluginConfig: PluginConfig, { nextRelease: { version }, logger }: PublishContext) => Promise<void>;

package/dist/publish.js

@@ -1,6 +1,6 @@
-import { execa } from 'execa';
-import { getConfig, getGoogleIdentityToken } from './utils.js';
-const SEMANTIC_RELEASE_PUB_TOKEN = 'SEMANTIC_RELEASE_PUB_TOKEN';
+import { execa } from "execa";
+import { getConfig, getGoogleIdentityToken } from "./utils.js";
+const SEMANTIC_RELEASE_PUB_TOKEN = "SEMANTIC_RELEASE_PUB_TOKEN";
 export const publish = async (pluginConfig, { nextRelease: { version }, logger }) => {
     const { cli, publishPub } = getConfig(pluginConfig);
     if (!publishPub) {
@@ -11,16 +11,16 @@ export const publish = async (pluginConfig, { nextRelease: { version }, logger }
     const idToken = await getGoogleIdentityToken(GOOGLE_SERVICE_ACCOUNT_KEY);
     await setPubToken(cli, idToken);
     logger.log(`Publishing version ${version} to pub.dev`);
-    await execa(cli, ['pub', 'publish', '--force']);
-    logger.log('Published package');
+    await execa(cli, ["pub", "publish", "--force"]);
+    logger.log("Published package");
 };
 const setPubToken = async (cli, idToken) => {
     process.env[SEMANTIC_RELEASE_PUB_TOKEN] = idToken;
     await execa(cli, [
-        'pub',
-        'token',
-        'add',
-        'https://pub.dev',
-        `--env-var=${SEMANTIC_RELEASE_PUB_TOKEN}`
+        "pub",
+        "token",
+        "add",
+        "https://pub.dev",
+        `--env-var=${SEMANTIC_RELEASE_PUB_TOKEN}`,
     ]);
 };

package/dist/schemas.d.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from "zod";
 export declare const ServiceAccount: z.ZodObject<{
     client_email: z.ZodString;
     private_key: z.ZodString;

package/dist/schemas.js

@@ -1,6 +1,6 @@
-import { z } from 'zod';
+import { z } from "zod";
 export const ServiceAccount = z.object({
     client_email: z.string(),
-    private_key: z.string()
+    private_key: z.string(),
 });
 export const Pubspec = z.object({ version: z.string() });

package/dist/types.d.ts

@@ -1,4 +1,5 @@
 export type PluginConfig = {
-    cli: 'dart' | 'flutter';
+    cli: "dart" | "flutter";
     publishPub: boolean;
+    updateBuildNumber: boolean;
 };

package/dist/utils.d.ts

@@ -1,3 +1,3 @@
-import { PluginConfig } from './types.js';
+import { PluginConfig } from "./types.js";
 export declare const getConfig: (config: PluginConfig) => PluginConfig;
 export declare const getGoogleIdentityToken: (serviceAccountStr: string) => Promise<string>;

package/dist/utils.js

@@ -1,11 +1,12 @@
-import SemanticReleaseError from '@semantic-release/error';
-import { JWT } from 'google-auth-library';
-import { ServiceAccount } from './schemas.js';
+import SemanticReleaseError from "@semantic-release/error";
+import { JWT } from "google-auth-library";
+import { ServiceAccount } from "./schemas.js";
 const DEFAULT_CONFIG = {
-    cli: 'dart',
-    publishPub: true
+    cli: "dart",
+    publishPub: true,
+    updateBuildNumber: false,
 };
-const PUB_DEV_AUDIENCE = 'https://pub.dev';
+const PUB_DEV_AUDIENCE = "https://pub.dev";
 export const getConfig = (config) => {
     return { ...DEFAULT_CONFIG, ...config };
 };
@@ -14,7 +15,7 @@ export const getGoogleIdentityToken = async (serviceAccountStr) => {
     const jwtClient = new JWT(serviceAccountJson.client_email, undefined, serviceAccountJson.private_key, PUB_DEV_AUDIENCE);
     const creds = await jwtClient.authorize();
     if (!creds.id_token) {
-        throw new SemanticReleaseError('Failed to retrieve identity token from Google');
+        throw new SemanticReleaseError("Failed to retrieve identity token from Google");
     }
     return creds.id_token;
 };

package/dist/verifyConditions.d.ts

@@ -1,3 +1,3 @@
-import { VerifyConditionsContext } from 'semantic-release';
-import { PluginConfig } from './types.js';
+import { VerifyConditionsContext } from "semantic-release";
+import { PluginConfig } from "./types.js";
 export declare const verifyConditions: (pluginConfig: PluginConfig, { logger }: VerifyConditionsContext) => Promise<void>;

package/dist/verifyConditions.js

@@ -1,12 +1,12 @@
-import SemanticReleaseError from '@semantic-release/error';
-import { execa } from 'execa';
-import { getConfig, getGoogleIdentityToken } from './utils.js';
+import SemanticReleaseError from "@semantic-release/error";
+import { execa } from "execa";
+import { getConfig, getGoogleIdentityToken } from "./utils.js";
 export const verifyConditions = async (pluginConfig, { logger }) => {
     const { cli, publishPub } = getConfig(pluginConfig);
     const { GOOGLE_SERVICE_ACCOUNT_KEY } = process.env;
     if (publishPub) {
         if (!GOOGLE_SERVICE_ACCOUNT_KEY) {
-            throw new SemanticReleaseError('Environment variable not found: GOOGLE_SERVICE_ACCOUNT_KEY');
+            throw new SemanticReleaseError("Environment variable not found: GOOGLE_SERVICE_ACCOUNT_KEY");
         }
         await getGoogleIdentityToken(GOOGLE_SERVICE_ACCOUNT_KEY);
         await verifyCommand(cli);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semantic-release-pub",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "semantic-release plugin to publish a Dart or Flutter package",
   "main": "dist/index.js",
   "author": "zeshuaro@gmail.com",
@@ -45,21 +45,22 @@
     "@types/semantic-release": "20.0.6",
     "@types/semantic-release__error": "3.0.3",
     "@types/signale": "1.4.7",
-    "@typescript-eslint/eslint-plugin": "6.13.2",
-    "@typescript-eslint/parser": "6.13.2",
-    "@vitest/coverage-v8": "1.0.1",
+    "@typescript-eslint/eslint-plugin": "6.17.0",
+    "@typescript-eslint/parser": "6.17.0",
+    "@vitest/coverage-v8": "1.1.1",
     "common-tags": "1.8.2",
     "conventional-changelog-conventionalcommits": "7.0.2",
-    "eslint": "8.55.0",
+    "eslint": "8.56.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-config-semistandard": "17.0.0",
     "eslint-config-standard": "17.1.0",
-    "eslint-plugin-import": "2.29.0",
-    "eslint-plugin-n": "16.3.1",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-n": "16.6.1",
     "eslint-plugin-promise": "6.1.1",
-    "prettier": "3.1.0",
-    "semantic-release": "22.0.10",
+    "prettier": "3.1.1",
+    "semantic-release": "22.0.12",
     "typescript": "5.3.3",
-    "vitest": "1.0.1",
+    "vitest": "1.1.1",
     "vitest-mock-extended": "1.3.1"
   }
 }