three-stdlib 2.23.2 → 2.23.3
Sign up to get free protection for your applications and to get access to all the features.
- package/LICENSE +21 -0
- package/README.md +44 -0
- package/package.json +2 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2021-2023 Poimandres
|
|
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,44 @@
|
|
|
1
|
+
# three-stdlib
|
|
2
|
+
|
|
3
|
+
[](https://npmjs.com/package/three-stdlib)
|
|
4
|
+
[](https://npmjs.com/package/three-stdlib)
|
|
5
|
+
[](https://twitter.com/pmndrs)
|
|
6
|
+
[](https://discord.gg/ZZjjNvJ)
|
|
7
|
+
[](https://github.com/pmndrs/three-stdlib/actions/workflows/main.yml)
|
|
8
|
+
|
|
9
|
+
Stand-alone version of [threejs/examples/jsm](https://github.com/mrdoob/three.js/tree/dev/examples/jsm) written in Typescript & built for ESM & CJS.
|
|
10
|
+
|
|
11
|
+
## Basic usage
|
|
12
|
+
|
|
13
|
+
npm install three-stdlib
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
// Export collection
|
|
17
|
+
import * as STDLIB from 'three-stdlib'
|
|
18
|
+
// Flatbundle
|
|
19
|
+
import { OrbitControls, ... } from 'three-stdlib'
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Problem
|
|
23
|
+
|
|
24
|
+
`threejs/examples` are usually regarded as something that you copy/paste into your project and adapt to your needs. That's not how people use it, and this has caused numerous issues in the past.
|
|
25
|
+
|
|
26
|
+
## Solution
|
|
27
|
+
|
|
28
|
+
- A build system for esm and cjs
|
|
29
|
+
- Version managed dependencies
|
|
30
|
+
- Class based, optimized for tree-shaking, no globals, exports instead of collections
|
|
31
|
+
- Single flatbundle as well as individual transpiles
|
|
32
|
+
- Typesafety with simple annotation-like types
|
|
33
|
+
- CI, tests, linting, formatting (prettier)
|
|
34
|
+
|
|
35
|
+
But most importantly, allowing more people that use and rely on these primitives to hold a little stake, and to share the weight of maintaining it.
|
|
36
|
+
|
|
37
|
+
## How to contribute
|
|
38
|
+
|
|
39
|
+
If you want to get involved you could do any of the following:
|
|
40
|
+
|
|
41
|
+
- Help to maintain and sync the existing primitives
|
|
42
|
+
- Create stories for these examples for our dedicated storybook
|
|
43
|
+
- Convert some of the files to Typescript
|
|
44
|
+
- Add new examples for the library you think could be helpful for others
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "three-stdlib",
|
|
3
|
-
"version": "2.23.
|
|
3
|
+
"version": "2.23.3",
|
|
4
4
|
"description": "stand-alone library of threejs examples",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"three",
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
"three": ">=0.128.0"
|
|
50
50
|
},
|
|
51
51
|
"scripts": {
|
|
52
|
-
"build": "rimraf dist && vite build && tsc --emitDeclarationOnly && copyfiles -u 1 \"src/**/*.d.ts\" dist && copyfiles package.json dist && json -I -f dist/package.json -e \"this.private=undefined; this.types=\\\"./index.d.ts\\\"; this.main=\\\"./index.cjs\\\"; this.module=\\\"./index.js\\\";\"",
|
|
52
|
+
"build": "rimraf dist && vite build && tsc --emitDeclarationOnly && copyfiles -u 1 \"src/**/*.d.ts\" dist && copyfiles package.json README.md LICENSE dist && json -I -f dist/package.json -e \"this.private=undefined; this.types=\\\"./index.d.ts\\\"; this.main=\\\"./index.cjs\\\"; this.module=\\\"./index.js\\\";\"",
|
|
53
53
|
"lint": "tsc --noEmit"
|
|
54
54
|
}
|
|
55
55
|
}
|