@mrshmllw/campfire 1.0.0-crumbs-feature-adding-some-default-configs.3 → 1.0.0-crumbs-feature-adding-some-default-configs.5

package/README.md

@@ -1 +1,75 @@
-# campfire
+# Campfire
+
+`campfire` is a collection internal configs, utils, and bits and pieces
+
+## Install
+
+```bash
+$ npm install -D @mrshmllw/campfire
+```
+
+## Making changes
+
+When making changes and creating PR's we use
+[semantic-releases](https://www.npmjs.com/package/semantic-release) which make
+use of [conventional-commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+So to ensure our CHANGELOG.md is updated automatically and gets the changes we
+have made, we just need to name our PR's following this convention (casing
+matters): e.g
+
+1. patch - fix(OPTIONAL bugfix-reference): some bugfix
+2. minor - feat(OPTIONAL feature-reference): some feature
+3. major - BREAKING CHANGE: some breaking change
+
+## Release
+
+Only the following branches are supported for release:
+
+- `main`
+- `feature/*`
+- `chore/*`
+- `fix/*`
+
+#### Preview
+
+Before releasing, you may want to see the changes that will be included in the
+next version deployed on NPM, you can do so by:
+
+1. Goto our
+   [github workflows](https://github.com/marshmallow-insurance/campfire/actions)
+2. Click `Preview Bump and Publish`
+3. Press `Run workflow` and select the `main` branch.
+4. Wait for the `Generate preview CHANGELOG.md` and look at the results!
+
+#### Releasing & Publishing
+
+When you're happy with your changes, you can release & publish your changes to
+NPM in one fell swoop by:
+
+1. Goto our
+   [github workflows](https://github.com/marshmallow-insurance/campfire/actions)
+2. Click `Bump and Publish`
+3. Press `Run workflow` and select the `main` branch.
+4. Wait for release!
+
+> [!NOTE] this workflow will fail if the package version is already on the latest, so you dont have to worry about deploying the same changes multiple times.
+
+> [!IMPORTANT] When re-using the release.config in other repos, you need to ensure that the package.json includes a repository URL.
+
+#### Pre-Releases
+
+Not too different to your usual workflow!
+
+1. Checkout a new branch with the prefix
+   `(feature|chore|fix)/<your-branch-name>` e.g. `feature/awesome-new-feature`
+2. Open a PR and create your changes as normal using semantic-commits!
+3. Goto our
+   [github workflows](https://github.com/marshmallow-insurance/campfire/actions)
+4. Click `Bump and Publish` or `Preview Bump and Publish`
+5. Press `Run workflow` and select `<your-full-branch-name>` branch.
+6. Wait for release!
+7. This can be done multiple times and it will increment your pre-release
+   package version!
+8. When you're happy with the changes, simply squash and merge the PR and
+   release `main`!

package/dist/configs/commitlint.config.d.ts

@@ -0,0 +1,3 @@
+import { UserConfig } from '@commitlint/types';
+export declare const config: UserConfig;
+export default config;

package/dist/configs/commitlint.config.js

@@ -1,12 +1,7 @@
 import { RuleConfigSeverity } from '@commitlint/types';
 export const config = {
     parserPreset: 'conventional-changelog-conventionalcommits',
-    ignores: [
-        (commit) => commit.startsWith('BREAKING CHANGE:'),
-        (commit) => commit.startsWith('BREAKING CHANGES:'),
-        (commit) => commit.startsWith('BREAKING-CHANGE:'),
-        (commit) => commit.startsWith('BREAKING-CHANGES:'),
-    ],
+    ignores: [(commit) => /^BREAKING(?:[- ]CHANGE(?:S)?):/.test(commit)],
     rules: {
         'type-case': [RuleConfigSeverity.Error, 'always', 'lower-case'],
         'type-empty': [RuleConfigSeverity.Error, 'never'],

package/dist/configs/eslint.config.d.ts

@@ -0,0 +1,24 @@
+export default config;
+declare const config: (import("eslint").Linter.FlatConfig | {
+    files: string[];
+    languageOptions: {
+        parser: typeof tsParser;
+    };
+    plugins: {
+        '@typescript-eslint': {
+            configs: Record<string, import("@typescript-eslint/utils/ts-eslint").ClassicConfig.Config>;
+            meta: import("@typescript-eslint/utils/ts-eslint").FlatConfig.PluginMeta;
+            rules: typeof import("@typescript-eslint/eslint-plugin/use-at-your-own-risk/rules");
+        };
+    };
+    rules: {
+        '@typescript-eslint/no-explicit-any': string;
+        '@typescript-eslint/explicit-function-return-type': string;
+        '@typescript-eslint/no-unused-vars': (string | {
+            argsIgnorePattern: string;
+        })[];
+        'no-console': string;
+        strict: string[];
+    };
+})[];
+import tsParser from '@typescript-eslint/parser';

package/dist/configs/lint-staged.config.d.ts

@@ -0,0 +1,5 @@
+export default config;
+declare const config: {
+    '*.+(js|ts|tsx)': string[];
+    '**/*.+(js|json|ts|tsx)': string[];
+};

package/dist/configs/prettier.config.d.ts

@@ -0,0 +1,8 @@
+export default config;
+declare namespace config {
+    let bracketSpacing: boolean;
+    let proseWrap: string;
+    let semi: boolean;
+    let singleQuote: boolean;
+    let trailingComma: string;
+}

package/dist/configs/release.config.d.ts

@@ -0,0 +1,5 @@
+export default config;
+/**
+ * @type {import('semantic-release').GlobalConfig}
+ */
+declare const config: import("semantic-release").GlobalConfig;

package/libs/configs/commitlint.config.ts

@@ -2,12 +2,7 @@ import { RuleConfigSeverity, UserConfig } from '@commitlint/types'
 
 export const config: UserConfig = {
   parserPreset: 'conventional-changelog-conventionalcommits',
-  ignores: [
-    (commit: string) => commit.startsWith('BREAKING CHANGE:'),
-    (commit: string) => commit.startsWith('BREAKING CHANGES:'),
-    (commit: string) => commit.startsWith('BREAKING-CHANGE:'),
-    (commit: string) => commit.startsWith('BREAKING-CHANGES:'),
-  ],
+  ignores: [(commit: string) => /^BREAKING(?:[- ]CHANGE(?:S)?):/.test(commit)],
   rules: {
     'type-case': [RuleConfigSeverity.Error, 'always', 'lower-case'],
     'type-empty': [RuleConfigSeverity.Error, 'never'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mrshmllw/campfire",
-  "version": "1.0.0-crumbs-feature-adding-some-default-configs.3",
+  "version": "1.0.0-crumbs-feature-adding-some-default-configs.5",
   "description": "Collection of toasty utils and configs used by Marshmallow Technology",
   "main": "index.js",
   "type": "module",

package/tsconfig.build.json

@@ -3,7 +3,8 @@
   "compilerOptions": {
     "rootDir": "libs",
     "baseUrl": "libs",
-    "outDir": "./dist"
+    "outDir": "./dist",
+    "declaration": true,
   },
   "exclude": [
     "release.config.js",