Skip to content

Commit c1de730

Browse files
florian-lefebvreflorian-lefebvre
authored
Initial commit
0 parents  commit c1de730

29 files changed

+6134
-0
lines changed

‎.changeset/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changesets
2+
3+
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
4+
with multi-package repos, or single-package repos to help you version and publish your code. You can
5+
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
6+
7+
We have a quick list of common questions to get you started engaging with this project in
8+
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

‎.changeset/config.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"commit": false,
5+
"fixed": [],
6+
"linked": [],
7+
"access": "public",
8+
"baseBranch": "main",
9+
"updateInternalDependencies": "patch",
10+
"ignore": ["playground"]
11+
}

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules

‎.vscode/settings.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"editor.defaultFormatter": "biomejs.biome"
3+
}

‎DELETE_ME.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Checklist
2+
3+
- [ ] Update all `TODO:`
4+
- [ ] Update all `package-name` occurences
5+
- [ ] Add a LICENSE.md at the root
6+
- [ ] Have gh cli installed
7+
- [ ] To create a release:
8+
- [ ] `pnpm run changeset`
9+
- [ ] Commit and push
10+
- [ ] `pnpm release`

‎README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# package-name
2+
3+
TODO:description
4+
5+
To see how to get started, check out the [package README](./package/README.md)
6+
7+
## Licensing
8+
9+
[MIT Licensed](./LICENSE). Made with ❤️ by [TODO:user](https://github.com/TODO:github-user).

‎biome.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"$schema": "https://biomejs.dev/schemas/1.5.2/schema.json",
3+
"organizeImports": {
4+
"enabled": true
5+
},
6+
"linter": {
7+
"enabled": true,
8+
"rules": {
9+
"recommended": true,
10+
"suspicious": {
11+
"noExplicitAny": "warn"
12+
}
13+
}
14+
},
15+
"files": {
16+
"ignore": ["dist"]
17+
}
18+
}

‎package.json‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"name": "root",
3+
"private": true,
4+
"packageManager": "[email protected]",
5+
"engines": {
6+
"node": ">=18.19.0"
7+
},
8+
"scripts": {
9+
"playground:dev": "pnpm --filter playground dev",
10+
"changeset": "changeset",
11+
"release": "node scripts/release.mjs",
12+
"lint": "biome check .",
13+
"lint:fix": "biome check --apply ."
14+
},
15+
"devDependencies": {
16+
"@biomejs/biome": "1.5.2",
17+
"@changesets/cli": "^2.27.1"
18+
}
19+
}

‎package/README.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# `package-name`
2+
3+
This is an [Astro integration](https://docs.astro.build/en/guides/integrations-guide/) that TODO:description
4+
5+
## Usage
6+
7+
### Prerequisites
8+
9+
TODO:
10+
11+
### Installation
12+
13+
Install the integration **automatically** using the Astro CLI:
14+
15+
```bash
16+
pnpm astro add package-name
17+
```
18+
19+
```bash
20+
npm astro add package-name
21+
```
22+
23+
```bash
24+
yarn astro add package-name
25+
```
26+
27+
Or install it **manually**:
28+
29+
1. Install the required dependencies
30+
31+
```bash
32+
pnpm add package-name
33+
```
34+
35+
```bash
36+
npm install package-name
37+
```
38+
39+
```bash
40+
yarn add package-name
41+
```
42+
43+
2. Add the integration to your astro config
44+
45+
```diff
46+
+import integration from "package-name";
47+
48+
export default defineConfig({
49+
integrations: [
50+
+ integration(),
51+
],
52+
});
53+
```
54+
55+
### Configuration
56+
57+
TODO:configuration
58+
59+
## Contributing
60+
61+
This package is structured as a monorepo:
62+
63+
- `playground` contains code for testing the package
64+
- `package` contains the actual package
65+
66+
Install dependencies using pnpm:
67+
68+
```bash
69+
pnpm i --frozen-lockfile
70+
```
71+
72+
Start the playground:
73+
74+
```bash
75+
pnpm playground:dev
76+
```
77+
78+
You can now edit files in `package`. Please note that making changes to those files may require restarting the playground dev server.
79+
80+
## Licensing
81+
82+
[MIT Licensed](https://github.com/TODO:/blob/main/LICENSE). Made with ❤️ by [TODO:](https://github.com/TODO:).
83+
84+
## Acknowledgements
85+
86+
TODO:

‎package/package.json‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "package-name",
3+
"version": "0.0.0",
4+
"description": "TODO:",
5+
"author": {
6+
"email": "TODO:",
7+
"name": "TODO:",
8+
"url": "TODO:"
9+
},
10+
"license": "MIT",
11+
"keywords": [
12+
"astro-integration",
13+
"astro-component",
14+
"withastro",
15+
"astro",
16+
"TODO:"
17+
],
18+
"homepage": "TODO:",
19+
"publishConfig": {
20+
"access": "public"
21+
},
22+
"sideEffects": false,
23+
"exports": {
24+
".": "./src/index.ts"
25+
},
26+
"scripts": {},
27+
"type": "module",
28+
"peerDependencies": {
29+
"astro": "^4.0.0"
30+
}
31+
}

0 commit comments

Comments
 (0)