@meistrari/mise-en-place 1.0.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/.github/workflows/publish.yaml +26 -0
- package/Makefile +22 -0
- package/README.md +52 -0
- package/eslint.ts +1 -0
- package/package.json +25 -0
- package/tsconfig.json +15 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
name: Publish SDK Package
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
paths:
|
|
8
|
+
- "package.json"
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
publish:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
steps:
|
|
14
|
+
- name: Checkout repository
|
|
15
|
+
uses: actions/checkout@v4
|
|
16
|
+
|
|
17
|
+
- name: Setup Bun
|
|
18
|
+
uses: oven-sh/setup-bun@v2
|
|
19
|
+
|
|
20
|
+
- name: Install dependencies
|
|
21
|
+
run: bun install --frozen-lockfile
|
|
22
|
+
|
|
23
|
+
- name: Publish mise-en-place package
|
|
24
|
+
run: bun publish --access public --no-git-checks
|
|
25
|
+
env:
|
|
26
|
+
NPM_CONFIG_TOKEN: ${{ secrets.NPM_TOKEN }}
|
package/Makefile
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
.PHONY: default
|
|
2
|
+
default: help
|
|
3
|
+
|
|
4
|
+
MISE_EN_PLACE_PACKAGE_NAME = @meistrari/mise-en-place
|
|
5
|
+
|
|
6
|
+
## Public commands
|
|
7
|
+
|
|
8
|
+
.editorconfig: ./node_modules/$(MISE_EN_PLACE_PACKAGE_NAME)/.editorconfig ## Copy/update .editorconfig file from @meistrari/mise-en-place package
|
|
9
|
+
@cp ./node_modules/$(MISE_EN_PLACE_PACKAGE_NAME)/.editorconfig .editorconfig
|
|
10
|
+
|
|
11
|
+
.PHONY: mise-en-place
|
|
12
|
+
mise-en-place: .editorconfig ## Setup the mise en place to start cooking
|
|
13
|
+
@echo "export { default } from '$(MISE_EN_PLACE_PACKAGE_NAME)/eslint'" > eslint.config.mjs
|
|
14
|
+
@echo "Mise en place is ready! 🍳"
|
|
15
|
+
|
|
16
|
+
## Hidden commands
|
|
17
|
+
|
|
18
|
+
.PHONY: help
|
|
19
|
+
help:
|
|
20
|
+
@echo "Make tasks:\n"
|
|
21
|
+
@grep -hE '^[%a-zA-Z_-]+:.*?## .*$$' Makefile ./node_modules/$(MISE_EN_PLACE_PACKAGE_NAME)/Makefile | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m %-17s\033[0m %s\n", $$1, $$2}'
|
|
22
|
+
@echo ""
|
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
Meistrari mise-en-place
|
|
2
|
+
---
|
|
3
|
+
|
|
4
|
+
Before cooking anything, it's important to have your mise en place ready. This project helps you set up your development environment with essential configurations and tools.
|
|
5
|
+
|
|
6
|
+
Start by installing the package as a development dependency:
|
|
7
|
+
```sh
|
|
8
|
+
npm i -D @meistrari/mise-en-place
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
After installing, it will create a `Makefile` in your project if one does not already exist.
|
|
12
|
+
If you already have a `Makefile`, you can manually include this project's Makefile by adding the following line to your existing `Makefile`:
|
|
13
|
+
```makefile
|
|
14
|
+
include ./node_modules/@meistrari/mise-en-place/Makefile
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Then, you can set up your mise en place by running:
|
|
18
|
+
```
|
|
19
|
+
make mise-en-place
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
This will run the initial setup for all mise en place features.
|
|
23
|
+
|
|
24
|
+
> This is intended to be run once when starting a new project. If you run this command again, it may overwrite existing configuration files.
|
|
25
|
+
|
|
26
|
+
# Features
|
|
27
|
+
|
|
28
|
+
## Makefile
|
|
29
|
+
Commands with `##` after the target are 'public' commands and are intended to be used by developers and will show up in the help message.
|
|
30
|
+
The other commands are 'hidden' and are intended to be used by automations or by other 'public' commands.
|
|
31
|
+
|
|
32
|
+
## EditorConfig
|
|
33
|
+
Run `make .editorconfig` to copy this project's `.editorconfig` to your project.
|
|
34
|
+
|
|
35
|
+
## Eslint Config
|
|
36
|
+
Add the following code in your `eslint.config.mjs` to include this project's ESLint configuration:
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
{
|
|
40
|
+
export { default } from '@vellone/techsak/eslint'
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## TSConfig
|
|
45
|
+
|
|
46
|
+
Add the following code in your `tsconfig.json` to include this project's TypeScript configuration:
|
|
47
|
+
|
|
48
|
+
```json
|
|
49
|
+
{
|
|
50
|
+
"extends": "./node_modules/@vellone/techsak/tsconfig.json"
|
|
51
|
+
}
|
|
52
|
+
```
|
package/eslint.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { default } from '@meistrari/mise-en-place/eslint'
|
package/package.json
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@meistrari/mise-en-place",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "git+https://github.com/meistrari/mise-en-place.git"
|
|
8
|
+
},
|
|
9
|
+
"scripts": {
|
|
10
|
+
"postinstall": "test -f Makefile || echo 'include ./node_modules/@meistrari/mise-en-place/Makefile' > Makefile"
|
|
11
|
+
},
|
|
12
|
+
"keywords": [],
|
|
13
|
+
"author": "",
|
|
14
|
+
"license": "ISC",
|
|
15
|
+
"type": "commonjs",
|
|
16
|
+
"bugs": {
|
|
17
|
+
"url": "https://github.com/meistrari/mise-en-place/issues"
|
|
18
|
+
},
|
|
19
|
+
"homepage": "https://github.com/meistrari/mise-en-place#readme",
|
|
20
|
+
"dependencies": {
|
|
21
|
+
"@antfu/eslint-config": "6.2.0",
|
|
22
|
+
"eslint-plugin-diff": "2.0.3",
|
|
23
|
+
"eslint-plugin-drizzle": "0.2.3"
|
|
24
|
+
}
|
|
25
|
+
}
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"strict": true,
|
|
4
|
+
|
|
5
|
+
"allowUnreachableCode": false,
|
|
6
|
+
"allowUnusedLabels": false,
|
|
7
|
+
"exactOptionalPropertyTypes": false,
|
|
8
|
+
"noImplicitOverride": true,
|
|
9
|
+
"noImplicitReturns": true,
|
|
10
|
+
"noPropertyAccessFromIndexSignature": false,
|
|
11
|
+
"noUncheckedIndexedAccess": true,
|
|
12
|
+
"noUnusedLocals": true,
|
|
13
|
+
"noUnusedParameters": true
|
|
14
|
+
}
|
|
15
|
+
}
|