mirror of
https://github.com/SrIzan10/starlight-typedoc.git
synced 2026-05-01 11:05:15 +00:00
chore: bootstrap project
This commit is contained in:
HiDeoo
3
.eslintrc.json
Normal file
3
.eslintrc.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": ["@hideoo"]
|
||||
}
|
||||
38
.github/workflows/integration.yml
vendored
Normal file
38
.github/workflows/integration.yml
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
name: Integration
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
workflow_call:
|
||||
|
||||
jobs:
|
||||
lint_test:
|
||||
name: Lint & Test
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Install pnpm
|
||||
uses: pnpm/action-setup@v2.2.4
|
||||
with:
|
||||
version: 8.6.1
|
||||
|
||||
- name: Install Node.js
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
cache: pnpm
|
||||
node-version: 18
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install
|
||||
|
||||
- name: Lint
|
||||
run: pnpm lint
|
||||
|
||||
- name: Test
|
||||
run: pnpm test
|
||||
51
.github/workflows/release.yml
vendored
Normal file
51
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,51 @@
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*.*.*'
|
||||
|
||||
jobs:
|
||||
integration:
|
||||
name: Integration
|
||||
uses: ./.github/workflows/integration.yml
|
||||
|
||||
publish:
|
||||
name: Publish
|
||||
needs:
|
||||
- integration
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
id-token: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Install pnpm
|
||||
uses: pnpm/action-setup@v2.2.4
|
||||
with:
|
||||
version: 8.6.1
|
||||
|
||||
- name: Install Node.js
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
cache: pnpm
|
||||
node-version: 18
|
||||
registry-url: 'https://registry.npmjs.org'
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install
|
||||
|
||||
- name: Publish
|
||||
run: pnpm publish --no-git-checks
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
NPM_CONFIG_PROVENANCE: true
|
||||
|
||||
- name: Generate changelog
|
||||
uses: hideoo/changelogithub-action@v1
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
32
.gitignore
vendored
Normal file
32
.gitignore
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
.astro
|
||||
.DS_Store
|
||||
.eslintcache
|
||||
.idea
|
||||
.next
|
||||
.turbo
|
||||
.vercel
|
||||
.vscode/*
|
||||
!.vscode/extensions.json
|
||||
!.vscode/launch.json
|
||||
!.vscode/settings.json
|
||||
!.vscode/tasks.json
|
||||
.vscode-test
|
||||
.vscode-test-web
|
||||
*.local
|
||||
*.log
|
||||
*.pem
|
||||
*.tsbuildinfo
|
||||
build
|
||||
coverage
|
||||
dist
|
||||
dist-ssr
|
||||
lerna-debug.log*
|
||||
logs
|
||||
next-env.d.ts
|
||||
node_modules
|
||||
npm-debug.log*
|
||||
out
|
||||
pnpm-debug.log*
|
||||
releases
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
4
.husky/pre-commit
Executable file
4
.husky/pre-commit
Executable file
@@ -0,0 +1,4 @@
|
||||
#!/usr/bin/env sh
|
||||
. "$(dirname -- "$0")/_/husky.sh"
|
||||
|
||||
pnpx lint-staged
|
||||
11
.prettierignore
Normal file
11
.prettierignore
Normal file
@@ -0,0 +1,11 @@
|
||||
.github/blocks
|
||||
.next
|
||||
.vercel
|
||||
.vscode-test
|
||||
.vscode-test-web
|
||||
build
|
||||
coverage
|
||||
dist
|
||||
dist-ssr
|
||||
out
|
||||
pnpm-lock.yaml
|
||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023-present, HiDeoo
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
33
README.md
33
README.md
@@ -1 +1,32 @@
|
||||
# starlight-typedoc
|
||||
<div align="center">
|
||||
<h1>starlight-typedoc 🚧</h1>
|
||||
<p>starlight-typedoc description</p>
|
||||
<p>
|
||||
<a href="https://dummyimage.com/520x350/121212/cdc8be.png&text=screenshot" title="Screenshot of starlight-typedoc">
|
||||
<img alt="Screenshot of starlight-typedoc" src="https://dummyimage.com/520x350/121212/cdc8be.png&text=screenshot" width="520" />
|
||||
</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
<a href="https://github.com/HiDeoo/starlight-typedoc/actions/workflows/integration.yml">
|
||||
<img alt="Integration Status" src="https://github.com/HiDeoo/starlight-typedoc/actions/workflows/integration.yml/badge.svg" />
|
||||
</a>
|
||||
<a href="https://github.com/HiDeoo/starlight-typedoc/blob/main/LICENSE">
|
||||
<img alt="License" src="https://badgen.net/github/license/HiDeoo/starlight-typedoc" />
|
||||
</a>
|
||||
<br />
|
||||
</div>
|
||||
|
||||
## Features
|
||||
|
||||
starlight-typedoc presentation.
|
||||
|
||||
- starlight-typedoc feature 1
|
||||
- starlight-typedoc feature 2
|
||||
|
||||
## License
|
||||
|
||||
Licensed under the MIT License, Copyright © HiDeoo.
|
||||
|
||||
See [LICENSE](https://github.com/HiDeoo/starlight-typedoc/blob/main/LICENSE) for more information.
|
||||
|
||||
44
package.json
Normal file
44
package.json
Normal file
@@ -0,0 +1,44 @@
|
||||
{
|
||||
"name": "starlight-typedoc",
|
||||
"version": "0.0.1",
|
||||
"license": "MIT",
|
||||
"description": "",
|
||||
"author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"test": "echo \"Error: no test implemented.\" && exit 1",
|
||||
"lint": "prettier -c --cache . && eslint . --cache --max-warnings=0 && tsc --noEmit",
|
||||
"prepare": "husky install",
|
||||
"prepublishOnly": "pnpm build"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@hideoo/eslint-config": "1.5.1",
|
||||
"@hideoo/prettier-config": "1.0.1",
|
||||
"@hideoo/tsconfig": "2.0.1",
|
||||
"eslint": "8.42.0",
|
||||
"husky": "8.0.3",
|
||||
"lint-staged": "13.2.2",
|
||||
"prettier": "2.8.8",
|
||||
"typescript": "5.1.3"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=18"
|
||||
},
|
||||
"packageManager": "pnpm@8.6.1",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"sideEffects": false,
|
||||
"keywords": [],
|
||||
"homepage": "https://github.com/HiDeoo/starlight-typedoc",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/HiDeoo/starlight-typedoc.git"
|
||||
},
|
||||
"bugs": "https://github.com/HiDeoo/starlight-typedoc/issues",
|
||||
"prettier": "@hideoo/prettier-config",
|
||||
"lint-staged": {
|
||||
"**/*": "prettier -w -u --cache",
|
||||
"**/*.{js,jsx,ts,tsx,cjs,mjs}": "eslint --cache --max-warnings=0"
|
||||
}
|
||||
}
|
||||
2832
pnpm-lock.yaml
generated
Normal file
2832
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
3
tsconfig.json
Normal file
3
tsconfig.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": "@hideoo/tsconfig"
|
||||
}
|
||||
Reference in New Issue
Block a user