Create one module file with rollup so the jsdoc comments will be preserved when using it as a module.

This commit is contained in:
kovacsv 2023-01-09 22:38:16 +01:00
parent 1718e9bb92
commit c2e41d1e0b
4 changed files with 53 additions and 13 deletions

View File

@ -1,7 +0,0 @@
path_classifiers:
library:
- libs/*.js
- libs/loaders/*.js
test:
- test
- sandbox

30
package-lock.json generated
View File

@ -1,12 +1,12 @@
{
"name": "online-3d-viewer",
"version": "0.8.20",
"version": "0.8.21",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "online-3d-viewer",
"version": "0.8.20",
"version": "0.8.21",
"license": "MIT",
"dependencies": {
"@simonwep/pickr": "1.8.2",
@ -27,6 +27,7 @@
"jsdoc": "^3.6.11",
"mocha": "^10.2.0",
"oslllo-svg-fixer": "^2.2.0",
"rollup": "^3.9.1",
"run-python3": "^0.0.4",
"svgo": "^3.0.2"
}
@ -4634,6 +4635,22 @@
"url": "https://github.com/sponsors/isaacs"
}
},
"node_modules/rollup": {
"version": "3.9.1",
"resolved": "https://registry.npmjs.org/rollup/-/rollup-3.9.1.tgz",
"integrity": "sha512-GswCYHXftN8ZKGVgQhTFUJB/NBXxrRGgO2NCy6E8s1rwEJ4Q9/VttNqcYfEvx4dTo4j58YqdC3OVztPzlKSX8w==",
"dev": true,
"bin": {
"rollup": "dist/bin/rollup"
},
"engines": {
"node": ">=14.18.0",
"npm": ">=8.0.0"
},
"optionalDependencies": {
"fsevents": "~2.3.2"
}
},
"node_modules/run-parallel": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
@ -8950,6 +8967,15 @@
"glob": "^7.1.3"
}
},
"rollup": {
"version": "3.9.1",
"resolved": "https://registry.npmjs.org/rollup/-/rollup-3.9.1.tgz",
"integrity": "sha512-GswCYHXftN8ZKGVgQhTFUJB/NBXxrRGgO2NCy6E8s1rwEJ4Q9/VttNqcYfEvx4dTo4j58YqdC3OVztPzlKSX8w==",
"dev": true,
"requires": {
"fsevents": "~2.3.2"
}
},
"run-parallel": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",

View File

@ -4,8 +4,7 @@
"description": "Online 3D Viewer",
"license": "MIT",
"type": "module",
"main": "./build/o3dv.min.js",
"module": "./source/engine/main.js",
"main": "./build/o3dv.module.js",
"repository": "github:kovacsv/Online3DViewer",
"keywords": [
"3d",
@ -32,6 +31,7 @@
],
"files": [
"build/o3dv.min.js",
"build/o3dv.module.js",
"source/engine/*",
"libs/loaders/*",
"website/assets/envmaps/*"
@ -47,12 +47,13 @@
"update_engine_exports": "run-python3 tools/update_engine_exports.py",
"create_dist": "npm run create_package && npm run lint && npm run test",
"create_dist_test": "npm run create_package_test && npm run lint && npm run test",
"create_package": "npm run docs && npm run build_engine_prod && npm run build_website_prod && npm run build_css_prod && run-python3 tools/create_package.py",
"create_package_test": "npm run docs && npm run build_engine_prod && npm run build_website_prod && npm run build_css_prod && run-python3 tools/create_package.py test",
"create_package": "npm run docs && npm run build_engine_prod && npm run build_engine_module && npm run build_website_prod && npm run build_css_prod && run-python3 tools/create_package.py",
"create_package_test": "npm run docs && npm run build_engine_prod && npm run build_engine_module && npm run build_website_prod && npm run build_css_prod && run-python3 tools/create_package.py test",
"build_css_prod": "cleancss -o build/o3dv.website.min.css website/css/*",
"build_dev": "npm run build_engine_dev && npm run build_website_dev",
"build_engine_dev": "npm run update_engine_exports && esbuild source/engine/main.js --bundle --minify --global-name=OV --sourcemap --outfile=build/o3dv.min-dev.js",
"build_engine_prod": "npm run update_engine_exports && esbuild source/engine/main.js --bundle --minify --global-name=OV --outfile=build/o3dv.min.js",
"build_engine_module": "npm run update_engine_exports && rollup --config tools/rollup.js",
"build_website_dev": "esbuild source/website/index.js --bundle --minify --global-name=OV --sourcemap --outfile=build/o3dv.website.min-dev.js",
"build_website_prod": "esbuild source/website/index.js --bundle --minify --global-name=OV --outfile=build/o3dv.website.min.js"
},
@ -66,6 +67,7 @@
"jsdoc": "^3.6.11",
"mocha": "^10.2.0",
"oslllo-svg-fixer": "^2.2.0",
"rollup": "^3.9.1",
"run-python3": "^0.0.4",
"svgo": "^3.0.2"
},

19
tools/rollup.js Normal file
View File

@ -0,0 +1,19 @@
export default [
{
input: 'source/engine/main.js',
output: {
file: 'build/o3dv.module.js',
format: 'es'
},
external: [
'fflate',
'three',
'three/examples/jsm/loaders/SVGLoader.js',
'three/examples/jsm/loaders/TGALoader.js',
'three/examples/jsm/loaders/FBXLoader.js',
'three/examples/jsm/loaders/ColladaLoader.js',
'three/examples/jsm/loaders/VRMLLoader.js',
'three/examples/jsm/loaders/3MFLoader.js'
]
}
];