From ce0c01347cc8b08458f8c78d0530bc935cd17f6e Mon Sep 17 00:00:00 2001 From: Olivers Vitins Date: Sat, 19 Aug 2023 18:35:41 +0300 Subject: [PATCH] feat: initial commit --- .gitignore | 3 + cspell.json | 12 ++++ package.json | 36 +++++++++++ pnpm-lock.yaml | 96 +++++++++++++++++++++++++++++ src/index.ts | 164 +++++++++++++++++++++++++++++++++++++++++++++++++ src/types.ts | 10 +++ tsconfig.json | 109 ++++++++++++++++++++++++++++++++ 7 files changed, 430 insertions(+) create mode 100644 .gitignore create mode 100644 cspell.json create mode 100644 package.json create mode 100644 pnpm-lock.yaml create mode 100644 src/index.ts create mode 100644 src/types.ts create mode 100644 tsconfig.json diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c58c7db --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +node_modules +dist +*.tgz \ No newline at end of file diff --git a/cspell.json b/cspell.json new file mode 100644 index 0000000..c8b5db3 --- /dev/null +++ b/cspell.json @@ -0,0 +1,12 @@ +{ + "version": "0.2", + "ignorePaths": [], + "dictionaryDefinitions": [], + "dictionaries": [], + "words": [ + "outro", + "rczrc" + ], + "ignoreWords": [], + "import": [] +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..a7dd55c --- /dev/null +++ b/package.json @@ -0,0 +1,36 @@ +{ + "name": "@resultium/rcz", + "version": "1.0.0-alpha.1", + "description": "Resultium commit standardization library, based on commitizen", + "main": "./dist/index.js", + "bin": { + "rcz": "./dist/index.js" + }, + "files": [ + "dist" + ], + "scripts": { + "build": "tsc" + }, + "repository": { + "type": "git", + "url": "https://git.resultium.net/technology/rcz.git" + }, + "keywords": [ + "conventional", + "commits" + ], + "author": { + "name": "Resultium", + "email": "contact@resultium.io", + "url": "https://www.resultium.io" + }, + "dependencies": { + "@clack/prompts": "^0.7.0", + "simple-git": "^3.19.1" + }, + "devDependencies": { + "@types/node": "^20.5.1", + "typescript": "^5.1.6" + } +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml new file mode 100644 index 0000000..ddee204 --- /dev/null +++ b/pnpm-lock.yaml @@ -0,0 +1,96 @@ +lockfileVersion: '6.0' + +settings: + autoInstallPeers: true + excludeLinksFromLockfile: false + +dependencies: + '@clack/prompts': + specifier: ^0.7.0 + version: 0.7.0 + simple-git: + specifier: ^3.19.1 + version: 3.19.1 + +devDependencies: + '@types/node': + specifier: ^20.5.1 + version: 20.5.1 + typescript: + specifier: ^5.1.6 + version: 5.1.6 + +packages: + + /@clack/core@0.3.3: + resolution: {integrity: sha512-5ZGyb75BUBjlll6eOa1m/IZBxwk91dooBWhPSL67sWcLS0zt9SnswRL0l26TVdBhb0wnWORRxUn//uH6n4z7+A==} + dependencies: + picocolors: 1.0.0 + sisteransi: 1.0.5 + dev: false + + /@clack/prompts@0.7.0: + resolution: {integrity: sha512-0MhX9/B4iL6Re04jPrttDm+BsP8y6mS7byuv0BvXgdXhbV5PdlsHt55dvNsuBCPZ7xq1oTAOOuotR9NFbQyMSA==} + dependencies: + '@clack/core': 0.3.3 + picocolors: 1.0.0 + sisteransi: 1.0.5 + dev: false + bundledDependencies: + - is-unicode-supported + + /@kwsites/file-exists@1.1.1: + resolution: {integrity: sha512-m9/5YGR18lIwxSFDwfE3oA7bWuq9kdau6ugN4H2rJeyhFQZcG9AgSHkQtSD15a8WvTgfz9aikZMrKPHvbpqFiw==} + dependencies: + debug: 4.3.4 + transitivePeerDependencies: + - supports-color + dev: false + + /@kwsites/promise-deferred@1.1.1: + resolution: {integrity: sha512-GaHYm+c0O9MjZRu0ongGBRbinu8gVAMd2UZjji6jVmqKtZluZnptXGWhz1E8j8D2HJ3f/yMxKAUC0b+57wncIw==} + dev: false + + /@types/node@20.5.1: + resolution: {integrity: sha512-4tT2UrL5LBqDwoed9wZ6N3umC4Yhz3W3FloMmiiG4JwmUJWpie0c7lcnUNd4gtMKuDEO4wRVS8B6Xa0uMRsMKg==} + dev: true + + /debug@4.3.4: + resolution: {integrity: sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==} + engines: {node: '>=6.0'} + peerDependencies: + supports-color: '*' + peerDependenciesMeta: + supports-color: + optional: true + dependencies: + ms: 2.1.2 + dev: false + + /ms@2.1.2: + resolution: {integrity: sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==} + dev: false + + /picocolors@1.0.0: + resolution: {integrity: sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==} + dev: false + + /simple-git@3.19.1: + resolution: {integrity: sha512-Ck+rcjVaE1HotraRAS8u/+xgTvToTuoMkT9/l9lvuP5jftwnYUp6DwuJzsKErHgfyRk8IB8pqGHWEbM3tLgV1w==} + dependencies: + '@kwsites/file-exists': 1.1.1 + '@kwsites/promise-deferred': 1.1.1 + debug: 4.3.4 + transitivePeerDependencies: + - supports-color + dev: false + + /sisteransi@1.0.5: + resolution: {integrity: sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==} + dev: false + + /typescript@5.1.6: + resolution: {integrity: sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==} + engines: {node: '>=14.17'} + hasBin: true + dev: true diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..ea4d124 --- /dev/null +++ b/src/index.ts @@ -0,0 +1,164 @@ +#!/usr/bin/env node + +import { + cancel, + confirm, + intro, + isCancel, + outro, + select, + text, +} from "@clack/prompts"; +import fs from "fs"; +import path from "path"; +import { Config } from "./types"; +import simpleGit from "simple-git"; + +const GetConfig = async () => { + if (fs.existsSync(path.join(process.cwd(), ".rczrc"))) { + return (await fs.promises.readFile( + path.join(process.cwd(), ".rczrc") + )) as Config; + } else { + return null; + } +}; + +(async () => { + const config = await GetConfig(); + + intro(`Creating a conventional commit message`); + + if (!fs.existsSync(path.join(process.cwd(), ".git"))) { + cancel("Git repository has not been initialized"); + process.exit(0); + } + + const stageAll = await confirm({ + message: "Stage all changes?", + initialValue: true, + }); + + if (isCancel(stageAll)) { + cancel("Commit creation cancelled"); + process.exit(0); + } + + const type: string | symbol = await select({ + message: "Choose a commit type", + options: [ + { + label: "feat", + value: "feat", + hint: "new feature", + }, + { + label: "fix", + value: "fix", + hint: "bug fix", + }, + { + label: "build", + value: "build", + hint: "changes that affect the build system, configs or external dependencies (e.g. npm, .prettierrc)", + }, + { + label: "ci", + value: "ci", + hint: "change to CI/CD configurations and scripts (e.g. CircleCI, GitHub workflows)", + }, + { + label: "docs", + value: "docs", + hint: "documentation changes (e.g. README, CHANGELOG)", + }, + { + label: "perf", + value: "perf", + hint: "code change, that improves performance", + }, + { + label: "refactor", + value: "refactor", + hint: "code change that neither fixes a bug nor adds a feature", + }, + ], + }); + + if (isCancel(type)) { + cancel("Commit creation cancelled"); + process.exit(0); + } + + const scope: string | symbol = await text({ + message: "Input a scope (e.g. router, forms, core) or leave empty", + validate: (value) => { + if (config?.scopes) { + if (!config?.scopes.includes(value)) + return "This scope is not allowed by local configuration"; + } + }, + }); + + if (isCancel(scope)) { + cancel("Commit creation cancelled"); + process.exit(0); + } + + const message = await text({ + message: `Briefly describe made changes in imperative tense, maximum length 50`, + validate: (value) => { + if (value.length > 50) { + return "Your message is too long"; + } + }, + }); + + if (isCancel(message)) { + cancel("Commit creation cancelled"); + process.exit(0); + } + + const isBreaking = await confirm({ + message: "Does this commit have breaking changes?", + initialValue: false, + }); + + if (isCancel(isBreaking)) { + cancel("Commit creation cancelled"); + process.exit(0); + } + + const resolvesIssue = await confirm({ + message: "Does this commit resolve an existing issue?", + initialValue: false, + }); + + if (isCancel(resolvesIssue)) { + cancel("Commit creation cancelled"); + process.exit(0); + } + + const issue = resolvesIssue + ? await text({ message: "Enter an issue identifier, e.g. #274" }) + : null; + + if (isCancel(issue)) { + cancel("Commit creation cancelled"); + process.exit(0); + } + + const commitMessage = `${type.toString()}${ + scope ? `(${scope.toString()})` : `` + }${isBreaking ? "!" : ""}: ${message.toString()}${ + resolvesIssue ? ` (${issue?.toString()})` : `` + }`; + + if (stageAll) { + await simpleGit().add(".").commit(commitMessage); + } else { + await simpleGit().commit(commitMessage); + } + + outro(`"${commitMessage}" - ready to push`); +})(); diff --git a/src/types.ts b/src/types.ts new file mode 100644 index 0000000..88aa539 --- /dev/null +++ b/src/types.ts @@ -0,0 +1,10 @@ +export interface Config { + commitTypes?: Array; + scopes?: Array; +} + +export interface Type { + label: string; + value: string; + hint: string; +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..67dd247 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,109 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs" /* Specify what module code is generated. */, + "rootDir": "./src/" /* Specify the root folder within your source files. */, + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + "outDir": "./dist/" /* Specify an output folder for all emitted files. */, + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */, + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, + + /* Type Checking */ + "strict": true /* Enable all strict type-checking options. */, + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}