@deseteral/biurko 0.0.0-stage → 0.2.0-SNAPSHOT.1
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 +7 -0
- package/README.md +50 -2
- package/package.json +79 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
Copyright Deseteral <github.com/deseteral>
|
|
2
|
+
|
|
3
|
+
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:
|
|
4
|
+
|
|
5
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
6
|
+
|
|
7
|
+
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.
|
package/README.md
CHANGED
|
@@ -1,3 +1,51 @@
|
|
|
1
|
-
#
|
|
1
|
+
# biurko
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## Installation
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
npm install --save @deseteral/biurko
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Development
|
|
10
|
+
|
|
11
|
+
### Setup
|
|
12
|
+
|
|
13
|
+
- Node.js `^22.18.0 || ^24.11.0 || >=26.0.0` for [Vite+](https://viteplus.dev/).
|
|
14
|
+
- npm 11.20.0 (the version pinned in `package.json` and used by CI and orb setup).
|
|
15
|
+
|
|
16
|
+
If needed, install the pinned npm version with `npm install --global npm@11.20.0`, then run `npm ci` to install dependencies from `package-lock.json`. Vite+ is installed locally; no global `vp` installation is required.
|
|
17
|
+
|
|
18
|
+
The project’s `.npmrc` saves exact dependency versions, disables install lifecycle scripts, and requires newly resolved package versions to be at least 31 days old. The release-age setting requires npm 11.10.0 or newer.
|
|
19
|
+
|
|
20
|
+
| Command | Description |
|
|
21
|
+
| ---------------------- | ------------------------------------------------------ |
|
|
22
|
+
| `npm run build` | Build the ESM library and declarations with `vp pack`. |
|
|
23
|
+
| `npm run build:demo` | Build all three demo pages with `vp build`. |
|
|
24
|
+
| `npm run demo` | Start the Vite+ dev server with the demo app. |
|
|
25
|
+
| `npm run typecheck` | Run TypeScript type checking. |
|
|
26
|
+
| `npm run lint` | Run Oxlint rules and type checking. |
|
|
27
|
+
| `npm run check` | Check formatting, lint rules, and types together. |
|
|
28
|
+
| `npm run format` | Format the project with Vite+ (Oxfmt). |
|
|
29
|
+
| `npm run format:check` | Check formatting without modifying files. |
|
|
30
|
+
|
|
31
|
+
`vp pack` builds the library; `vp build demo/` builds the demo application. To run these local commands directly, use `npm exec --no -- vp`. There are currently no tests or test script.
|
|
32
|
+
|
|
33
|
+
Formatting uses the `fmt` block in `vite.config.ts` and the existing `.editorconfig` style. Linting uses Oxlint's default rules with type-aware linting and type checking enabled in the `lint` block. Linting includes the library and demo code, excluding generated output. `vp check` checks formatting, lint rules, and types together; TypeScript checking remains available separately through `npm run typecheck`.
|
|
34
|
+
|
|
35
|
+
CI runs formatting checks, type checking, and both builds on pushes and pull requests. Orb setup installs the pinned npm version when needed and runs `npm ci`; resume requires no additional setup.
|
|
36
|
+
|
|
37
|
+
### Demo app
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
npm run demo
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
This starts a local dev server serving the `demo/` directory. There are three demo apps available:
|
|
44
|
+
|
|
45
|
+
- `/` - vanilla DOM demo
|
|
46
|
+
- `/react.html` - React integration demo
|
|
47
|
+
- `/solid.html` - SolidJS integration demo
|
|
48
|
+
|
|
49
|
+
## License
|
|
50
|
+
|
|
51
|
+
This project is licensed under the [MIT license](LICENSE).
|
package/package.json
CHANGED
|
@@ -1,6 +1,81 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@deseteral/biurko",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.2.0-SNAPSHOT.1",
|
|
4
|
+
"description": "A browser window manager with React and SolidJS adapters.",
|
|
5
|
+
"homepage": "https://github.com/Deseteral/biurko#readme",
|
|
6
|
+
"bugs": {
|
|
7
|
+
"url": "https://github.com/Deseteral/biurko/issues"
|
|
8
|
+
},
|
|
9
|
+
"license": "MIT",
|
|
10
|
+
"author": "Deseteral",
|
|
11
|
+
"repository": {
|
|
12
|
+
"type": "git",
|
|
13
|
+
"url": "git+https://github.com/Deseteral/biurko.git"
|
|
14
|
+
},
|
|
15
|
+
"files": [
|
|
16
|
+
"dist"
|
|
17
|
+
],
|
|
18
|
+
"type": "module",
|
|
19
|
+
"types": "./dist/index.d.ts",
|
|
20
|
+
"exports": {
|
|
21
|
+
".": {
|
|
22
|
+
"types": "./dist/index.d.ts",
|
|
23
|
+
"import": "./dist/index.js"
|
|
24
|
+
},
|
|
25
|
+
"./adapters/solid-js": {
|
|
26
|
+
"types": "./dist/adapters/solid-js/index.d.ts",
|
|
27
|
+
"import": "./dist/adapters/solid-js/index.js"
|
|
28
|
+
},
|
|
29
|
+
"./adapters/react": {
|
|
30
|
+
"types": "./dist/adapters/react/index.d.ts",
|
|
31
|
+
"import": "./dist/adapters/react/index.js"
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"publishConfig": {
|
|
35
|
+
"access": "public"
|
|
36
|
+
},
|
|
37
|
+
"scripts": {
|
|
38
|
+
"build": "vp pack",
|
|
39
|
+
"build:demo": "vp build demo/",
|
|
40
|
+
"prepack": "npm run typecheck && npm run build",
|
|
41
|
+
"typecheck": "tsc --noEmit",
|
|
42
|
+
"lint": "vp lint",
|
|
43
|
+
"check": "vp check",
|
|
44
|
+
"format": "vp fmt",
|
|
45
|
+
"format:check": "vp fmt --check",
|
|
46
|
+
"demo": "vp dev demo/"
|
|
47
|
+
},
|
|
48
|
+
"devDependencies": {
|
|
49
|
+
"@types/node": "26.6.3",
|
|
50
|
+
"@types/react": "19.3.0",
|
|
51
|
+
"@types/react-dom": "19.3.0",
|
|
52
|
+
"@vitejs/plugin-react": "6.1.1",
|
|
53
|
+
"react": "19.3.0",
|
|
54
|
+
"react-dom": "19.3.0",
|
|
55
|
+
"solid-js": "1.9.15",
|
|
56
|
+
"typescript": "7.0.2",
|
|
57
|
+
"vite": "npm:@voidzero-dev/vite-plus-core@1.4.0",
|
|
58
|
+
"vite-plugin-solid": "2.11.14",
|
|
59
|
+
"vite-plus": "1.4.0"
|
|
60
|
+
},
|
|
61
|
+
"peerDependencies": {
|
|
62
|
+
"react": ">=18.0.0",
|
|
63
|
+
"react-dom": ">=18.0.0",
|
|
64
|
+
"solid-js": ">=1.8.0"
|
|
65
|
+
},
|
|
66
|
+
"peerDependenciesMeta": {
|
|
67
|
+
"solid-js": {
|
|
68
|
+
"optional": true
|
|
69
|
+
},
|
|
70
|
+
"react": {
|
|
71
|
+
"optional": true
|
|
72
|
+
},
|
|
73
|
+
"react-dom": {
|
|
74
|
+
"optional": true
|
|
75
|
+
}
|
|
76
|
+
},
|
|
77
|
+
"overrides": {
|
|
78
|
+
"vite": "npm:@voidzero-dev/vite-plus-core@1.4.0"
|
|
79
|
+
},
|
|
80
|
+
"packageManager": "npm@11.20.0"
|
|
81
|
+
}
|