Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kurone-kito/horaro
I'll seek to automate workflow in my live streaming.
https://github.com/kurone-kito/horaro
empty yet
Last synced: about 1 month ago
JSON representation
I'll seek to automate workflow in my live streaming.
- Host: GitHub
- URL: https://github.com/kurone-kito/horaro
- Owner: kurone-kito
- License: mit
- Created: 2023-07-31T10:12:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-31T10:12:10.000Z (over 1 year ago)
- Last Synced: 2023-07-31T11:26:36.946Z (over 1 year ago)
- Topics: empty, yet
- Homepage: https://gist.github.com/kurone-kito/1e3702eb0534916cf37e27b439374872
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📄 Yarn project boilerplate
## Features
- Yarn with PnP
- TypeScript
- ESLint
- Prettier
- Visual Studio Code / Vim ready
- CI / CD configurations
- Dependabot
- GitHub Actions
## System Requirements
- Node.js Gallium LTS (`^16.20.1`)
- Yarn (`>=2.4.3`)
## Install the dependencies
```sh
yarn install
```
## Linting
```sh
yarn run lint
yarn run lint:fix # Lint and auto-fix
```
## Testing
```sh
yarn run test
```
Currently, the command works as an alias for the `yarn run lint` command.
## Cleaning
```sh
yarn run clean
```
## Migrate to NPM
### 1. Remove the following files
- `.yarn/`
- `.yarnrc.yml`
- `yarn.lock`
### 2. Apply the following patches
```diff
--- a/.github/workflows/push.yml
+++ b/.github/workflows/push.yml
@@ -13,16 +13,14 @@ jobs:
- name: Prepare the Node.js version ${{ matrix.node-version }} environment
uses: actions/setup-node@v2
with:
- cache: ${{ !env.ACT && 'yarn' || '' }}
+ cache: ${{ !env.ACT && 'npm' || '' }}
node-version: ${{ matrix.node-version }}
- - name: Install the Yarn
- run: npm install --global yarn@berry
+ - name: set npm config
+ run: npm config set unsafe-perm true
- env:
HUSKY: 0
name: Install the dependencies
- run: yarn install --inline-builds
+ run: npm ci
- name: Run the tests
- run: yarn run test
+ run: npm test
strategy:
matrix:
node-version:
```
```diff
--- a/.husky/commit-msg
+++ b/.husky/commit-msg
@@ -4,4 +4,4 @@
. "$(dirname "$0")/_/husky.sh"
-yarn exec commitlint --edit "${1}"
+npm x --no -- commitlint --edit "${1}"
```
```diff
--- a/.husky/pre-commit
+++ b/.husky/pre-commit
@@ -4,4 +4,4 @@
. "$(dirname "$0")/_/husky.sh"
-yarn exec lint-staged
+npm x --no -- lint-staged
```
```diff
--- a/.vim/coc-settings.json
+++ b/.vim/coc-settings.json
@@ -1,6 +1,4 @@
{
- "eslint.nodePath": ".yarn/sdks",
- "eslint.packageManager": "yarn",
- "tsserver.tsdk": ".yarn/sdks/typescript/lib",
+ "tsserver.tsdk": "node_modules/typescript/lib",
"workspace.workspaceFolderCheckCwd": false
}
```
```diff
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -1,18 +1,9 @@
{
- "eslint.nodePath": ".yarn/sdks",
"files.watcherExclude": {
- "**/.eslintcache": true,
- "**/.pnp.*": true,
- "**/.yarn/cache/**": true,
- "**/.yarn/unplugged/**": true
+ "**/.eslintcache": true
},
- "prettier.prettierPath": ".yarn/sdks/prettier/index.js",
- "search.exclude": {
- "**/.pnp.*": true,
- "**/.yarn": true
- },
"typescript.enablePromptUseWorkspaceTsdk": true,
- "typescript.tsdk": ".yarn/sdks/typescript/lib"
+ "typescript.tsdk": "node_modules/typescript/lib"
"yaml.schemas": {
"https://raw.githubusercontent.com/reviewpad/schemas/main/latest/schema.json": [
"reviewpad.yml"
```
```diff
--- a/package.json
+++ b/package.json
@@ -16,16 +16,16 @@
"files": [],
"scripts": {
"clean": "rimraf -g \".eslintcache\" \"*.tgz\" \"*.tsbuildinfo\"",
- "postinstall": "husky install",
- "lint": "conc -m 1 \"yarn:lint:*:check\"",
+ "lint": "conc -m 1 \"npm:lint:*:check\"",
"lint:cspell:check": "cspell lint --no-progress --show-suggestions -u \"./**/*\"",
"lint:eslint:check": "eslint --cache --cache-strategy=content -f codeframe \"./**/*\"",
- "lint:eslint:fix": "yarn run lint:eslint:check --fix",
- "lint:fix": "conc -m 1 \"yarn:lint:*:fix\"",
- "lint:prettier:check": "yarn run prettier -cu",
- "lint:prettier:fix": "yarn run prettier -uw",
- "prettier": "prettier --cache --loglevel=warn \"$@\" \"./**/*\"",
- "test": "yarn run lint"
+ "lint:eslint:fix": "npm run lint:eslint:check -- --fix",
+ "lint:fix": "conc -m 1 \"npm:lint:*:fix\"",
+ "lint:prettier:check": "npm run prettier -- -cu",
+ "lint:prettier:fix": "npm run prettier -- -uw",
+ "prepare": "husky install",
+ "prettier": "prettier --cache --loglevel=warn \"./**/*\"",
+ "test": "npm run lint"
},
"prettier": "@kurone-kito/prettier-config",
"devDependencies": {
@@ -36,7 +36,6 @@
"@kurone-kito/eslint-config-base": "^0.7.0",
"@kurone-kito/prettier-config": "^0.7.0",
"@kurone-kito/typescript-config": "^0.7.0",
- "@yarnpkg/sdks": "^3.0.0-rc.48",
"concurrently": "^8.2.0",
"cspell": "^6.31.2",
"eslint": "^8.45.0",
@@ -62,7 +61,6 @@
"typescript": "~5.1.6",
"typescript-eslint-language-service": "^5.0.5"
},
- "packageManager": "[email protected]",
"engines": {
"node": ">=16.20"
},
```
### 3. Run the following command
```sh
npm install
git add -A
git commit -m "feat: migrate to NPM from Yarn"
```
## Rules for Development
Introduce commit message validation at commit time.
The “**[Conventional Commits](https://www.conventionalcommits.org/ja/)**”
rule is applied to discourage committing messages that violate conventions.
## LICENSE
MIT