@tymonmarek/wally 0.1.0

package/docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,82 @@
+# Contributor Covenant Code of Conduct
+
+## Table of Contents
+
+- [Our Pledge](#our-pledge)
+- [Our Standards](#our-standards)
+- [Our Responsibilities](#our-responsibilities)
+- [Scope](#scope)
+- [Enforcement](#enforcement)
+- [Attribution](#attribution)
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at {{ email }}. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
+
+[homepage]: https://www.contributor-covenant.org

package/docs/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+We welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your help is greatly appreciated.
+
+## Table of Contents
+
+- [How to Contribute](#how-to-contribute)
+- [Code of Conduct](#code-of-conduct)
+- [Reporting Issues](#reporting-issues)
+- [Submitting Pull Requests](#submitting-pull-requests)
+- [Style Guidelines](#style-guidelines)
+- [Getting Help](#getting-help)
+
+## How to Contribute
+
+1. Fork the repository to your own GitHub account.
+2. Clone the forked repository to your local machine.
+3. Create a new branch for your feature or bug fix.
+4. Make your changes and commit them with clear messages.
+5. Push your changes to your forked repository.
+6. Open a pull request against the main repository.
+
+## Code of Conduct
+
+We expect all contributors to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it to understand the standards we uphold in our community.
+
+## Reporting Issues
+
+If you encounter a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible, including steps to reproduce the issue, expected behavior, and any relevant screenshots or logs.
+
+## Submitting Pull Requests
+
+When submitting a pull request, please ensure that:
+
+- Your code follows the project's coding style and conventions.
+- You have added tests for any new functionality.
+- All existing tests pass.
+- You have updated documentation as necessary.
+- You provide a clear description of the changes made.
+
+## Style Guidelines
+
+Please follow these style guidelines to maintain code consistency:
+
+- Use meaningful variable and function names.
+- Write clear and concise comments.
+- Follow the project's indentation and formatting rules.
+- Ensure your code is modular and reusable.
+- Avoid large commits; break changes into smaller, manageable pieces.
+
+## Getting Help
+
+If you need assistance or have questions, feel free to reach out to the community through our discussion forums or chat channels. We're here to help!
+
+Thank you for contributing to our project! Your efforts help make it better for everyone.

package/docs/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+We take the security of our project seriously. This document outlines our security policy, including how to report vulnerabilities and our approach to handling security issues.
+
+## Table of Contents
+
+- [Reporting a Vulnerability](#reporting-a-vulnerability)
+- [Supported Versions](#supported-versions)
+- [Security Updates](#security-updates)
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in our project, please report it using GitHub's [Security Advisories](https://docs.github.com/en/code-security/security-advisories) feature. This allows us to manage the disclosure process effectively and ensures that we can address the issue promptly.
+
+## Supported Versions
+
+Please refer to our [Releases](https://github.com/TymonMarek/semantic-release-plugin-template/releases) page for detailed information on each version's support status and updates.
+
+## Security Updates
+
+We are committed to addressing security vulnerabilities in a timely manner. Once a vulnerability is reported, we will investigate and, if confirmed, work on a fix as quickly as possible. Security updates will be communicated through our GitHub repository and release notes.

package/eslint.config.mts

@@ -0,0 +1,30 @@
+import * as js from "@eslint/js";
+import * as globals from "globals";
+import tseslint from "typescript-eslint";
+import markdown from "@eslint/markdown";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+  {
+    files: ["src/**/*.{ts,mts,cts}"],
+    plugins: { js },
+    extends: ["js/recommended"],
+    languageOptions: { globals: globals.node },
+  },
+  tseslint.configs.recommended,
+  {
+    files: ["tests/**/*.{ts,mts,cts}"],
+    plugins: { js },
+    extends: ["js/recommended"],
+    languageOptions: { globals: { ...globals.node, ...globals.jest } },
+  },
+  {
+    ignores: ["dist/**", "node_modules/**", "**/*.d.ts"],
+  },
+  {
+    files: ["**/*.md"],
+    plugins: { markdown },
+    language: "markdown/gfm",
+    extends: ["markdown/recommended"],
+  },
+]);

package/jest.config.ts

@@ -0,0 +1,202 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+import type { Config } from "@jest/types";
+
+const config: Config.InitialOptions = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "C:\\Users\\Tymon\\AppData\\Local\\Temp\\jest",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "mts",
+  //   "cts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  preset: "ts-jest",
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.?([mc])[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).?([mc])[jt]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    "^.+\\.ts$": "ts-jest", // Transform TypeScript files with ts-jest
+    "^.+\\.js$": "ts-jest", // Transform JavaScript files too (for packages like @semantic-release/error)
+  },
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  transformIgnorePatterns: [
+    "/node_modules/(?!@semantic-release|other-modules-to-include)/", // Transform the required modules that use ES modules
+  ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+export default config;

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@tymonmarek/wally",
+  "version": "0.1.0",
+  "description": "A minimal plugin template for semantic-release.",
+  "main": "build/index.js",
+  "homepage": "https://github.com/TymonMarek/wally",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TymonMarek/wally.git"
+  },
+  "author": "Tymon Marek <tymon.marek@icloud.com>",
+  "bugs": {
+    "email": "tymon.marek@icloud.com",
+    "url": "https://github.com/TymonMarek/wally/issues"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "eslint --fix -c eslint.config.mts .",
+    "format": "prettier --write .",
+    "test": "jest",
+    "prepare": "husky",
+    "pre-commit": "lint-staged",
+    "audit": "corepack npm audit signatures",
+    "prepublishOnly": "npm run build",
+    "release": "semantic-release"
+  },
+  "lint-staged": {
+    "!(*.d).ts": [
+      "eslint --fix --config eslint.config.mts",
+      "prettier --write --config prettier.config.ts"
+    ],
+    "*.md": [
+      "npm run lint"
+    ]
+  },
+  "release": {
+    "branches": [
+      "main",
+      {
+        "name": "beta",
+        "prerelease": true
+      },
+      {
+        "name": "alpha",
+        "prerelease": true
+      }
+    ],
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      [
+        "@semantic-release/changelog",
+        {
+          "changelogFile": "docs/CHANGELOG.md"
+        }
+      ],
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "CHANGELOG.md",
+            "package.json",
+            "package-lock.json"
+          ],
+          "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        }
+      ],
+      "@semantic-release/npm",
+      "@semantic-release/github"
+    ]
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@eslint/json": "^1.0.0",
+    "@eslint/markdown": "^7.5.1",
+    "@jest/globals": "^30.2.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@tsconfig/node20": "^20.1.8",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.2.0",
+    "@types/semantic-release__error": "^3.0.3",
+    "@types/signale": "^1.4.7",
+    "corepack": "^0.34.6",
+    "eslint": "^9.39.2",
+    "globals": "^17.3.0",
+    "husky": "^9.1.7",
+    "jest": "^30.2.0",
+    "jiti": "^2.6.1",
+    "lint-staged": "^16.2.7",
+    "prettier": "3.8.1",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.54.0"
+  },
+  "dependencies": {
+    "semantic-release": "^25.0.3"
+  }
+}

package/src/error.ts

@@ -0,0 +1,30 @@
+import SemanticReleaseError from "@semantic-release/error";
+
+import { homepage } from "../package.json";
+
+export const link = (file: string) => `${homepage}/blob/main/${file}`;
+
+export type ErrorDefinition = {
+  message: string;
+  details: string;
+};
+
+export const enum ErrorCode {
+  WallyNotInstalled,
+}
+
+export const ERROR_DEFINITIONS: Record<ErrorCode, ErrorDefinition> = {
+  [ErrorCode.WallyNotInstalled]: {
+    message: "Wally is not installed.",
+    details: `Wally must be installed to use this plugin. Please install Wally by following the instructions at ${link("README.md#installation")}.`,
+  },
+};
+
+export function getError(errorCode: ErrorCode): SemanticReleaseError {
+  const definition = ERROR_DEFINITIONS[errorCode];
+  return new SemanticReleaseError(
+    definition.message,
+    errorCode.toString(),
+    definition.details,
+  );
+}

package/src/index.ts

@@ -0,0 +1,56 @@
+// import {
+//   AnalyzeCommitsContext,
+//   GenerateNotesContext,
+//   PublishContext,
+//   PrepareContext,
+//   VerifyConditionsContext,
+//   VerifyReleaseContext,
+//   SuccessContext,
+//   FailContext,
+//   GlobalConfig,
+// } from "semantic-release";
+
+// export async function verifyConditions(
+//   pluginConfig: GlobalConfig,
+//   context: VerifyConditionsContext,
+// ) {}
+
+// export async function analyzeCommits(
+//   pluginConfig: GlobalConfig,
+//   context: AnalyzeCommitsContext,
+// ) {}
+
+// export async function verifyRelease(
+//   pluginConfig: GlobalConfig,
+//   context: VerifyReleaseContext,
+// ) {}
+
+// export async function generateNotes(
+//   pluginConfig: GlobalConfig,
+//   context: GenerateNotesContext,
+// ) {}
+
+// export async function addChannel(
+//   pluginConfig: GlobalConfig,
+//   context: VerifyReleaseContext,
+// ) {}
+
+// export async function prepare(
+//   pluginConfig: GlobalConfig,
+//   context: PrepareContext,
+// ) {}
+
+// export async function publish(
+//   pluginConfig: GlobalConfig,
+//   context: PublishContext,
+// ) {}
+
+// export async function success(
+//   pluginConfig: GlobalConfig,
+//   context: SuccessContext,
+// ) {}
+
+// export async function fail(
+//   pluginConfig: GlobalConfig,
+//   context: FailContext,
+// ) {}

package/tests/error.test.ts

@@ -0,0 +1,31 @@
+import SemanticReleaseError from "@semantic-release/error";
+import { ERROR_DEFINITIONS, ErrorCode, getError, link } from "../src/error";
+
+test("error definition generates error link correctly", () => {
+  expect(link("README.md#usage")).toBe(
+    "https://github.com/TymonMarek/wally/blob/main/README.md#usage",
+  );
+});
+
+test("error definition generates error link without fragment", () => {
+  expect(link("src/index.ts")).toBe(
+    "https://github.com/TymonMarek/wally/blob/main/src/index.ts",
+  );
+});
+
+test("error definition generates error link with empty input", () => {
+  expect(link("")).toBe("https://github.com/TymonMarek/wally/blob/main/");
+});
+
+test("getError generates SemanticReleaseError with correct properties", () => {
+  const semanticError = getError(ErrorCode.WallyNotInstalled);
+
+  expect(semanticError).toBeInstanceOf(SemanticReleaseError);
+  expect(semanticError.message).toBe(
+    ERROR_DEFINITIONS[ErrorCode.WallyNotInstalled].message,
+  );
+  expect(semanticError.code).toBe(ErrorCode.WallyNotInstalled.toString());
+  expect(semanticError.details).toBe(
+    ERROR_DEFINITIONS[ErrorCode.WallyNotInstalled].details,
+  );
+});

package/tsconfig.build.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+    "rootDir": "./src",
+    "outDir": "./build"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["tests/**/*.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+
+  "compilerOptions": {
+    "lib": ["ESNext"],
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+
+    "strict": true,
+    "alwaysStrict": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+
+    "noImplicitAny": true,
+    "noUnusedLocals": true,
+    "noImplicitThis": true,
+    "noErrorTruncation": true,
+    "noUnusedParameters": true,
+    "forceConsistentCasingInFileNames": true,
+
+    "esModuleInterop": true,
+    "skipLibCheck": false,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "removeComments": true
+  }
+}