@theholocron/devmoji-config 8.9.0-alpha.1 → 8.9.0-alpha.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +1 -1
  2. package/dist/index.d.cts +8 -0
  3. package/dist/index.d.mts +8 -0
  4. package/package.json +10 -10
package/README.md CHANGED
@@ -59,4 +59,4 @@ npx husky add .husky/prepare-commit-msg "npx devmoji -e --lint"
59
59
 
60
60
  ## Releases
61
61
 
62
- Versioned in lockstep with all other `@theholocron/` config packages. See the [releases page](https://github.com/theholocron/configs/releases).
62
+ Versioned in lockstep with all other `@theholocron/` config packages. See the [releases page](https://github.com/theholocron/holocron/releases) (tags `configs-v*`).
package/dist/index.d.cts CHANGED
@@ -1,11 +1,19 @@
1
+ /** One devmoji mapping from a commit type or scope to the emoji it gets. */
1
2
  export interface DevmojiEntry {
3
+ /** The commit type or scope the entry applies to (for example `feat`). */
2
4
  code: string;
5
+ /** The name of the emoji devmoji uses for the code (for example `boom`). */
3
6
  emoji?: string;
7
+ /** The name of the gitmoji devmoji uses for the code (for example `wrench`). */
4
8
  gitmoji?: string;
9
+ /** A short note on when to use the code. */
5
10
  description?: string;
6
11
  }
12
+ /** The shape of a devmoji configuration file. */
7
13
  export interface DevmojiConfig {
14
+ /** Extra commit types devmoji recognises, added to the defaults. */
8
15
  types?: string[];
16
+ /** Mappings from a commit code to an emoji, added to or overriding the defaults. */
9
17
  devmoji?: DevmojiEntry[];
10
18
  }
11
19
  /**
package/dist/index.d.mts CHANGED
@@ -1,11 +1,19 @@
1
+ /** One devmoji mapping from a commit type or scope to the emoji it gets. */
1
2
  export interface DevmojiEntry {
3
+ /** The commit type or scope the entry applies to (for example `feat`). */
2
4
  code: string;
5
+ /** The name of the emoji devmoji uses for the code (for example `boom`). */
3
6
  emoji?: string;
7
+ /** The name of the gitmoji devmoji uses for the code (for example `wrench`). */
4
8
  gitmoji?: string;
9
+ /** A short note on when to use the code. */
5
10
  description?: string;
6
11
  }
12
+ /** The shape of a devmoji configuration file. */
7
13
  export interface DevmojiConfig {
14
+ /** Extra commit types devmoji recognises, added to the defaults. */
8
15
  types?: string[];
16
+ /** Mappings from a commit code to an emoji, added to or overriding the defaults. */
9
17
  devmoji?: DevmojiEntry[];
10
18
  }
11
19
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theholocron/devmoji-config",
3
- "version": "8.9.0-alpha.1",
3
+ "version": "8.9.0-alpha.16",
4
4
  "description": "Shared devmoji configuration for conventional commit emojis.",
5
5
  "keywords": [
6
6
  "devmoji",
@@ -41,12 +41,12 @@
41
41
  "dist/"
42
42
  ],
43
43
  "devDependencies": {
44
- "@vitest/coverage-v8": "^5.0.5",
45
- "tsdown": "^0.23.3",
44
+ "@vitest/coverage-v8": "^5.1.0",
45
+ "tsdown": "^0.23.5",
46
46
  "typescript": "^5.9.3",
47
- "vitest": "^5.0.5",
48
- "@theholocron/tsconfig": "8.9.0-alpha.1",
49
- "@theholocron/vitest-config": "8.9.0-alpha.1"
47
+ "vitest": "^5.1.0",
48
+ "@theholocron/tsconfig": "8.9.0-alpha.16",
49
+ "@theholocron/vitest-config": "8.9.0-alpha.16"
50
50
  },
51
51
  "engines": {
52
52
  "node": ">=22.0.0"
@@ -55,10 +55,10 @@
55
55
  "access": "public"
56
56
  },
57
57
  "scripts": {
58
- "delivery.build": "tsdown",
59
- "sourceQuality.staticAnalysis": "eslint .",
58
+ "build": "tsdown",
59
+ "lint:code": "eslint .",
60
+ "test:unit": "vitest run --coverage",
60
61
  "test:watch": "vitest",
61
- "verification.typeSafety": "tsc --noEmit",
62
- "verification.unitTests": "vitest run"
62
+ "typecheck": "tsc --noEmit"
63
63
  }
64
64
  }