@sobird/murph 1.2.0
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.
- package/LICENSE +21 -0
- package/README.md +54 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.js +1 -0
- package/package.json +59 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 sobird
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# @sobird/murph
|
|
2
|
+
A pristine TypeScript template for rapid project inception.
|
|
3
|
+
|
|
4
|
+
[![npm][npm]][npm-url]
|
|
5
|
+
![TypeScript][typescript]
|
|
6
|
+
![Node.js][node]
|
|
7
|
+
![CLI][cli]
|
|
8
|
+
[![Build Status][build-status]][build-status-url]
|
|
9
|
+
[![License][license]][license-url]
|
|
10
|
+
[![Install Size][size]][size-url]
|
|
11
|
+
|
|
12
|
+
## 🛠️ Step into the Singularity
|
|
13
|
+
|
|
14
|
+
Don't just clone. **Incept.** The fastest way to bootstrap your next pristine project is via `degit`, ensuring zero git history contamination.
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
# Incept a new project in the current directory
|
|
18
|
+
npx degit sobird/murph .
|
|
19
|
+
|
|
20
|
+
# Or, incept in a specific folder
|
|
21
|
+
npx degit sobird/murph my-new-dimension
|
|
22
|
+
|
|
23
|
+
# Initialize the equation
|
|
24
|
+
pnpm install
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### 🛰️ Engineering & Governance
|
|
28
|
+
|
|
29
|
+
`murph` adheres to the highest standards of automated software delivery. Every change is tracked, and every release is predictable.
|
|
30
|
+
|
|
31
|
+
- **[Conventional Commits](https://www.conventionalcommits.org/)**: Every commit follows a strict semantic structure to ensure clarity and machine-readability.
|
|
32
|
+
- **[Release Please](https://github.com/googleapis/release-please)**: Automated versioning and changelog generation. No manual `npm version` required.
|
|
33
|
+
- **[Provenance](https://docs.npmjs.com/generating-provenance-statements)**: Every NPM release includes a build provenance statement, linking the package directly to its GitHub source.
|
|
34
|
+
|
|
35
|
+
### 🤖 CI/CD Pipeline
|
|
36
|
+
|
|
37
|
+
The singularity is maintained through an automated lifecycle:
|
|
38
|
+
1. **Commit**: Developers push `feat:`, `fix:`, or `docs:` commits.
|
|
39
|
+
2. **Review**: A release PR is automatically maintained by `release-please`.
|
|
40
|
+
3. **Ascension**: Upon merging the release PR, the package is built, tested, and published to NPM with an OIDC-authenticated handshake.
|
|
41
|
+
|
|
42
|
+
<!-- Badges -->
|
|
43
|
+
|
|
44
|
+
[npm]: https://img.shields.io/npm/v/@sobird/murph.svg?style=flat-square&logo=npm&label=@sobird/murph
|
|
45
|
+
[npm-url]: https://www.npmjs.com/package/@sobird/murph
|
|
46
|
+
[build-status]: https://img.shields.io/github/actions/workflow/status/sobird/murph/release.yml?label=CI&logo=github&style=flat-square
|
|
47
|
+
[build-status-url]: https://github.com/sobird/murph/actions
|
|
48
|
+
[size]: https://img.shields.io/badge/dynamic/json?style=flat-square&label=mass&query=$.publish.pretty&url=https://packagephobia.com/v2/api.json?p=@sobird/murph&color=blueviolet
|
|
49
|
+
[size-url]: https://packagephobia.com/result?p=@sobird/murph
|
|
50
|
+
[license]: https://img.shields.io/github/license/sobird/murph.svg?style=flat-square
|
|
51
|
+
[license-url]: https://github.com/sobird/murph/blob/master/LICENSE
|
|
52
|
+
[typescript]: https://img.shields.io/badge/-TypeScript-3178C6?style=flat-square&logo=typescript&logoColor=white
|
|
53
|
+
[cli]: https://img.shields.io/badge/-CLI-000000?style=flat-square&logo=gnu-bash
|
|
54
|
+
[node]: https://img.shields.io/badge/-Node.js-339933?style=flat-square&logo=node.js&logoColor=white
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
var i="@sobird/murph";var e="1.2.0";function s(){console.log(i,e),console.log("A pristine TypeScript singularity.");}s();export{s as murph};
|
package/package.json
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@sobird/murph",
|
|
3
|
+
"type": "module",
|
|
4
|
+
"version": "1.2.0",
|
|
5
|
+
"packageManager": "pnpm@10.30.3",
|
|
6
|
+
"description": "A pristine TypeScript template for rapid project inception.",
|
|
7
|
+
"author": "sobird",
|
|
8
|
+
"license": "MIT",
|
|
9
|
+
"homepage": "https://github.com/sobird/murph",
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "git+https://github.com/sobird/murph.git"
|
|
13
|
+
},
|
|
14
|
+
"bugs": {
|
|
15
|
+
"url": "https://github.com/sobird/murph/issues"
|
|
16
|
+
},
|
|
17
|
+
"keywords": [
|
|
18
|
+
"typescript"
|
|
19
|
+
],
|
|
20
|
+
"main": "./dist/index.js",
|
|
21
|
+
"module": "./dist/index.js",
|
|
22
|
+
"types": "./dist/index.d.ts",
|
|
23
|
+
"files": [
|
|
24
|
+
"dist"
|
|
25
|
+
],
|
|
26
|
+
"engines": {
|
|
27
|
+
"node": ">=18.0.0"
|
|
28
|
+
},
|
|
29
|
+
"scripts": {
|
|
30
|
+
"build": "tsup",
|
|
31
|
+
"lint": "eslint",
|
|
32
|
+
"lint:fix": "eslint --fix",
|
|
33
|
+
"test": "vitest run --passWithNoTests --coverage",
|
|
34
|
+
"typecheck": "tsc --noEmit",
|
|
35
|
+
"postinstall": "echo \"postinstall\"",
|
|
36
|
+
"prepare": "husky"
|
|
37
|
+
},
|
|
38
|
+
"devDependencies": {
|
|
39
|
+
"@commitlint/cli": "^20.5.0",
|
|
40
|
+
"@commitlint/config-conventional": "^20.5.0",
|
|
41
|
+
"@types/node": "^25.5.0",
|
|
42
|
+
"@vitest/coverage-v8": "4.1.0",
|
|
43
|
+
"eslint": "^9.39.4",
|
|
44
|
+
"eslint-config-sobird": "^1.1.1",
|
|
45
|
+
"husky": "^9.1.7",
|
|
46
|
+
"lint-staged": "^16.4.0",
|
|
47
|
+
"tsup": "^8.5.1",
|
|
48
|
+
"tsx": "^4.21.0",
|
|
49
|
+
"typescript": "^5.9.3",
|
|
50
|
+
"vitest": "^4.1.0"
|
|
51
|
+
},
|
|
52
|
+
"lint-staged": {
|
|
53
|
+
"*": "eslint --fix"
|
|
54
|
+
},
|
|
55
|
+
"publishConfig": {
|
|
56
|
+
"registry": "https://registry.npmjs.org/",
|
|
57
|
+
"access": "public"
|
|
58
|
+
}
|
|
59
|
+
}
|