wordflow-dataset 0.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/LICENSE +21 -0
- package/README.md +74 -0
- package/dist/cli.cjs +12 -0
- package/dist/cli.cjs.map +1 -0
- package/dist/cli.d.cts +1 -0
- package/dist/cli.d.mts +1 -0
- package/dist/cli.mjs +13 -0
- package/dist/cli.mjs.map +1 -0
- package/dist/index.cjs +10 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +5 -0
- package/dist/index.d.mts +5 -0
- package/dist/index.mjs +8 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +54 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 beeman https://github.com/beeman
|
|
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,74 @@
|
|
|
1
|
+
# wordflow-dataset
|
|
2
|
+
|
|
3
|
+
This is a template for creating a modern TypeScript library or package using [Bun](https://bun.sh/). It comes pre-configured with essential tools for development, testing, linting, and publishing.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
* **Bun-first development**: Leverages Bun for lightning-fast installs, runs, and tests.
|
|
8
|
+
* **TypeScript support**: Write type-safe code from the start.
|
|
9
|
+
* **Linting & Formatting**: Enforced with [Biome](https://biomejs.dev/) for consistent code style.
|
|
10
|
+
* **Bundling**: Uses [tsdown](https://tsdown.js.org/) for efficient bundling into ESM and CJS formats, with type declarations.
|
|
11
|
+
* **Testing**: Built-in unit testing with `bun test`.
|
|
12
|
+
* **Versioning & Publishing**: Managed with [Changesets](https://github.com/changesets/changesets) for streamlined releases to npm.
|
|
13
|
+
* **GitHub Actions**: Continuous Integration (CI) workflows for automated build, test, lint, and publish processes.
|
|
14
|
+
|
|
15
|
+
## Getting Started
|
|
16
|
+
|
|
17
|
+
To use this template, you typically would use a scaffolding tool like `bunx create-something -t wordflow-dataset`.
|
|
18
|
+
|
|
19
|
+
### Installation
|
|
20
|
+
|
|
21
|
+
If you're using this template directly (e.g., after cloning), you can install dependencies with Bun:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
bun install
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Development
|
|
28
|
+
|
|
29
|
+
* **Build**: `bun run build`
|
|
30
|
+
* **Type Check**: `bun run check-types`
|
|
31
|
+
* **Lint**: `bun run lint`
|
|
32
|
+
* **Lint & Fix**: `bun run lint:fix`
|
|
33
|
+
* **Test**: `bun test`
|
|
34
|
+
* **Test (Watch Mode)**: `bun run test:watch`
|
|
35
|
+
|
|
36
|
+
### Publishing
|
|
37
|
+
|
|
38
|
+
This template uses Changesets for versioning and publishing.
|
|
39
|
+
|
|
40
|
+
1. **Add a changeset**:
|
|
41
|
+
```bash
|
|
42
|
+
bun changeset
|
|
43
|
+
```
|
|
44
|
+
Follow the prompts to describe your changes. This will create a markdown file in `.changeset/`.
|
|
45
|
+
|
|
46
|
+
2. **Version packages**:
|
|
47
|
+
```bash
|
|
48
|
+
bun run version
|
|
49
|
+
```
|
|
50
|
+
This command reads the changeset files, updates package versions, updates `CHANGELOG.md`, and deletes the used changeset files. It also runs `bun lint:fix`.
|
|
51
|
+
|
|
52
|
+
3. **Publish to npm**:
|
|
53
|
+
```bash
|
|
54
|
+
bun run release
|
|
55
|
+
```
|
|
56
|
+
This command builds the package and publishes it to npm. Ensure you are logged into npm (`npm login`) or have `NPM_TOKEN` configured in your CI environment.
|
|
57
|
+
|
|
58
|
+
## Project Structure
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
.
|
|
62
|
+
├── src/ # Source code for your library
|
|
63
|
+
│ └── index.ts # Main entry point for your library
|
|
64
|
+
├── test/ # Unit tests
|
|
65
|
+
│ └── index.test.ts # Example test file
|
|
66
|
+
├── tsdown.config.ts # Configuration for tsdown (bundling)
|
|
67
|
+
├── biome.json # Biome linter/formatter configuration
|
|
68
|
+
├── package.json # Project metadata and scripts
|
|
69
|
+
└── ... (other config files and GitHub workflows)
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## License
|
|
73
|
+
|
|
74
|
+
MIT – see [LICENSE](./LICENSE).
|
package/dist/cli.cjs
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
#!/usr/bin/env bun
|
|
2
|
+
const require_index = require('./index.cjs');
|
|
3
|
+
|
|
4
|
+
//#region src/cli.ts
|
|
5
|
+
function main() {
|
|
6
|
+
const name = process.argv[2] || "World";
|
|
7
|
+
console.log(require_index.greet(name));
|
|
8
|
+
}
|
|
9
|
+
main();
|
|
10
|
+
|
|
11
|
+
//#endregion
|
|
12
|
+
//# sourceMappingURL=cli.cjs.map
|
package/dist/cli.cjs.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.cjs","names":["greet"],"sources":["../src/cli.ts"],"sourcesContent":["#!/usr/bin/env bun\n\nimport { greet } from './index.ts'\n\nfunction main() {\n const name = process.argv[2] || 'World'\n console.log(greet(name))\n}\n\nmain()\n"],"mappings":";;;;AAIA,SAAS,OAAO;CACd,MAAM,OAAO,QAAQ,KAAK,MAAM;AAChC,SAAQ,IAAIA,oBAAM,KAAK,CAAC;;AAG1B,MAAM"}
|
package/dist/cli.d.cts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { };
|
package/dist/cli.d.mts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { };
|
package/dist/cli.mjs
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
#!/usr/bin/env bun
|
|
2
|
+
import { greet } from "./index.mjs";
|
|
3
|
+
|
|
4
|
+
//#region src/cli.ts
|
|
5
|
+
function main() {
|
|
6
|
+
const name = process.argv[2] || "World";
|
|
7
|
+
console.log(greet(name));
|
|
8
|
+
}
|
|
9
|
+
main();
|
|
10
|
+
|
|
11
|
+
//#endregion
|
|
12
|
+
export { };
|
|
13
|
+
//# sourceMappingURL=cli.mjs.map
|
package/dist/cli.mjs.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.mjs","names":[],"sources":["../src/cli.ts"],"sourcesContent":["#!/usr/bin/env bun\n\nimport { greet } from './index.ts'\n\nfunction main() {\n const name = process.argv[2] || 'World'\n console.log(greet(name))\n}\n\nmain()\n"],"mappings":";;;;AAIA,SAAS,OAAO;CACd,MAAM,OAAO,QAAQ,KAAK,MAAM;AAChC,SAAQ,IAAI,MAAM,KAAK,CAAC;;AAG1B,MAAM"}
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
|
+
|
|
3
|
+
//#region src/index.ts
|
|
4
|
+
function greet(name = "World") {
|
|
5
|
+
return `Hello, ${name} from wordflow-dataset!`;
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
//#endregion
|
|
9
|
+
exports.greet = greet;
|
|
10
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.cjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["export function greet(name: string = 'World'): string {\n return `Hello, ${name} from wordflow-dataset!`\n}\n"],"mappings":";;;AAAA,SAAgB,MAAM,OAAe,SAAiB;AACpD,QAAO,UAAU,KAAK"}
|
package/dist/index.d.cts
ADDED
package/dist/index.d.mts
ADDED
package/dist/index.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["export function greet(name: string = 'World'): string {\n return `Hello, ${name} from wordflow-dataset!`\n}\n"],"mappings":";AAAA,SAAgB,MAAM,OAAe,SAAiB;AACpD,QAAO,UAAU,KAAK"}
|
package/package.json
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
{
|
|
2
|
+
"bin": {
|
|
3
|
+
"wordflow-dataset": "dist/cli.mjs"
|
|
4
|
+
},
|
|
5
|
+
"dependencies": {},
|
|
6
|
+
"devDependencies": {
|
|
7
|
+
"@biomejs/biome": "2.4.6",
|
|
8
|
+
"@changesets/cli": "^2.29.8",
|
|
9
|
+
"@intellectronica/ruler": "^0.3.34",
|
|
10
|
+
"@types/bun": "^1.3.9",
|
|
11
|
+
"pkg-pr-new": "^0.0.62",
|
|
12
|
+
"publint": "^0.3.16",
|
|
13
|
+
"tsdown": "^0.20.3"
|
|
14
|
+
},
|
|
15
|
+
"exports": {
|
|
16
|
+
".": {
|
|
17
|
+
"import": {
|
|
18
|
+
"types": "./dist/index.d.mts",
|
|
19
|
+
"default": "./dist/index.mjs"
|
|
20
|
+
},
|
|
21
|
+
"require": {
|
|
22
|
+
"types": "./dist/index.d.cts",
|
|
23
|
+
"default": "./dist/index.cjs"
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
"files": [
|
|
28
|
+
"dist"
|
|
29
|
+
],
|
|
30
|
+
"license": "MIT",
|
|
31
|
+
"main": "./dist/index.cjs",
|
|
32
|
+
"module": "./dist/index.mjs",
|
|
33
|
+
"name": "wordflow-dataset",
|
|
34
|
+
"peerDependencies": {
|
|
35
|
+
"typescript": "^5"
|
|
36
|
+
},
|
|
37
|
+
"scripts": {
|
|
38
|
+
"build": "tsdown",
|
|
39
|
+
"changeset": "changeset",
|
|
40
|
+
"check-types": "tsc -b --noEmit",
|
|
41
|
+
"ci": "bun run build && bun run lint && bun run check-types && bun test",
|
|
42
|
+
"lint": "biome check --error-on-warnings",
|
|
43
|
+
"lint:fix": "biome check --error-on-warnings --write",
|
|
44
|
+
"release": "changeset publish",
|
|
45
|
+
"ruler:apply": "ruler apply --local-only",
|
|
46
|
+
"test": "bun test",
|
|
47
|
+
"test:watch": "bun test --watch",
|
|
48
|
+
"version": "changeset version && bun lint:fix"
|
|
49
|
+
},
|
|
50
|
+
"type": "module",
|
|
51
|
+
"types": "./dist/index.d.mts",
|
|
52
|
+
"version": "0.0.0",
|
|
53
|
+
"description": ""
|
|
54
|
+
}
|