create-threlte - npm Package Compare versions

Comparing version 1.0.0-next.15 to 1.0.0

CHANGELOG.md

 # create-threlte
 
+## 1.0.0
+
+### Major Changes
+
+- 7f64e75: breaking: bumped create-svelte to use Svelte 4
+
+### Minor Changes
+
+- 6b219b5: Updated create-svelte, added options to initialize a git repository and install dependencies via preferred package manager.
+- e61b376: Added model pipeline feature to create command, added docs for create command
+
+### Patch Changes
+
+- a78b413: Fixed a bug where transformed models would be transformed again
+- 568b8c0: Added three.js dependency
+- a107ec7: Fixed targetDir preconfiguration
+- 718f285: Fixed shared basic Scene.svelte templates
+- ea2ff82: Added proper dep versions
+- 020359a: Removed files from package.json
+- defe0f1: Prototype of create package
+- ab88499: Added basic examples for core and extras, fixed dev
+- 7ac7c20: Added root configuration option, preconfigured
+- d111d18: Added shebang line
+- 4c930d8: TypeScript should exclude the templates
+- 0099894: Moved create-svelte to dependencies
+- 51de433: Edited root page
+- 4d40c88: Fixed package name in intro
+- 09a07a2: Added core dependency, added modified vite config
+
 ## 1.0.0-next.15
@@ -4,0 +33,0 @@

dist/bin.js

@@ -131,3 +131,3 @@ #!/usr/bin/env node
             three: '^0.153.0',
-            '@threlte/core': 'next'
+            '@threlte/core': 'latest'
         },
@@ -140,10 +140,10 @@ scripts: {}
     if (options.threltePackages.includes('@threlte/extras')) {
-        threltePackageJson.devDependencies['@threlte/extras'] = 'next';
+        threltePackageJson.devDependencies['@threlte/extras'] = 'latest';
     }
     if (options.threltePackages.includes('@threlte/rapier')) {
-        threltePackageJson.devDependencies['@threlte/rapier'] = 'next';
+        threltePackageJson.devDependencies['@threlte/rapier'] = 'latest';
         threltePackageJson.devDependencies['@dimforge/rapier3d-compat'] = '^0.11.2';
     }
     if (options.threltePackages.includes('@threlte/theatre')) {
-        threltePackageJson.devDependencies['@threlte/theatre'] = 'next';
+        threltePackageJson.devDependencies['@threlte/theatre'] = 'latest';
         threltePackageJson.devDependencies['@theatre/core'] = '^0.6.1';
@@ -153,3 +153,3 @@ threltePackageJson.devDependencies['@theatre/studio'] = '^0.6.1';
     if (options.threltePackages.includes('model-pipeline')) {
-        threltePackageJson.devDependencies['@threlte/extras'] = 'next';
+        threltePackageJson.devDependencies['@threlte/extras'] = 'latest';
         threltePackageJson.scripts['model-pipeline:run'] = 'node scripts/model-pipeline.js';
@@ -238,7 +238,7 @@ }
         print(bold('✔ @threlte/extras'));
-        print(cyan('  https://next.threlte.xyz/docs/reference/extras/getting-started\n'));
+        print(cyan('  https://threlte.xyz/docs/reference/extras/getting-started\n'));
     }
     if (options.threltePackages.includes('@threlte/rapier')) {
         print(bold('✔ @threlte/rapier'));
-        print(cyan('  https://next.threlte.xyz/docs/reference/rapier/getting-started'));
+        print(cyan('  https://threlte.xyz/docs/reference/rapier/getting-started'));
         print(cyan('  https://rapier.rs/\n'));
@@ -248,3 +248,3 @@ }
         print(bold('✔ @threlte/theatre'));
-        print(cyan('  https://next.threlte.xyz/docs/reference/theatre/getting-started'));
+        print(cyan('  https://threlte.xyz/docs/reference/theatre/getting-started'));
         print(cyan('  https://www.theatrejs.com/\n'));
@@ -255,3 +255,3 @@ }
         print(cyan(`  ${pkgManager} run model-pipeline:run`));
-        print(cyan('  https://next.threlte.xyz/docs/reference/gltf/getting-started\n'));
+        print(cyan('  https://threlte.xyz/docs/reference/gltf/getting-started\n'));
     }
@@ -258,0 +258,0 @@ if (options.git) {

dist/templates/model-pipeline+javascript/scripts/model-pipeline.js

@@ -88,3 +88,3 @@ import { execSync } from 'node:child_process'
   // run the command
-  const cmd = `npx @threlte/gltf@next ${path} ${formattedArgs}`
+  const cmd = `npx @threlte/gltf@latest ${path} ${formattedArgs}`
   try {
@@ -91,0 +91,0 @@ execSync(cmd, {

dist/templates/model-pipeline+typescript/scripts/model-pipeline.js

@@ -88,3 +88,3 @@ import { execSync } from 'node:child_process'
   // run the command
-  const cmd = `npx @threlte/gltf@next ${path} ${formattedArgs}`
+  const cmd = `npx @threlte/gltf@latest ${path} ${formattedArgs}`
   try {
@@ -91,0 +91,0 @@ execSync(cmd, {

package.json

 {
   "name": "create-threlte",
-  "version": "1.0.0-next.15",
+  "version": "1.0.0",
   "author": "Grischa Erbe <[e-mail]> (https://legrisch.com)",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -1,1 +0,61 @@
-# create-threlte
+<div align="right">
+ <a href="https://www.npmjs.com/package/create-threlte">
+  <img alt="npm" src="https://img.shields.io/npm/v/create-threlte?color=fe4100&labelColor=171d27&logo=npm&logoColor=white"/>
+ </a>
+ <a href="https://github.com/threlte/threlte/blob/main/LICENSE.md">
+  <img alt="license" src="https://img.shields.io/npm/l/@threlte/core?color=fe4100&labelColor=171d27&logo=git&logoColor=white"/>
+ </a>
+ <a href="https://discord.com/channels/985983540804091964">
+  <img alt="discord" src="https://img.shields.io/discord/985983540804091964?label=discord&color=fe4100&labelColor=171d27&logo=discord&logoColor=white"/>
+ </a>
+ <a href="https://threlte.xyz">
+  <img alt="docs" src="https://img.shields.io/website?down_color=red&down_message=offline&label=docs&color=fe4100&labelColor=171d27&up_message=online&url=https%3A%2F%2Fthrelte.xyz&logo=svelte&logoColor=white"/>
+ </a>
+</div>
+
+<a href="https://threlte.xyz">
+ <img src="./threlte-banner.jpg"/>
+</a>
+
+## Rapidly Build Interactive 3D Apps for the Web
+
+Threlte is a [Svelte](https://svelte.dev/) library that simplifies creating 3D apps for the web. It provides a **declarative**, **type-safe**, **reactive** and **interactive** API out-of-the-box.
+
+Threlte's **3D rendering** is powered by [Three.js](https://threejs.org/), and it also provides a **physics engine** through [Rapier](https://rapier.rs/) and an **animation studio** via [Theatre.js](https://www.theatrejs.com/); see [packages](#packages) for details.
+
+Check out our **[documentation](https://threlte.xyz)** and our **[Discord community](https://discord.gg/EqUBCfCaGm)**.
+
+## create-threlte
+
+This is the official [npm create](https://docs.npmjs.com/cli/v6/commands/npm-init) command for Threlte projects.
+
+## Usage
+
+To use `create-threlte` to initialize a fresh Threlte project, run:
+
+```sh
+npm create threlte my-project
+```
+
+You well then enter an interactive prompt that allows you to select options for configuring both SvelteKit and Threlte.
+
+### Support
+
+Have questions? Feel free to ask in our [Discord support forum](https://discord.com/channels/985983540804091964/1031843197963477002).
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+- **Filing Issues** - if you have feature requestions or you think you spotted a bug, [submit an issue](https://github.com/threlte/threlte/issues/new).
+- **Contributing Code** - if you would like to drop us a PR, read the [contribution guide](https://github.com/threlte/threlte/blob/main/CONTRIBUTING.md) first.
+
+## Sponsors
+
+[![Powered by Vercel](./assets/vercel/powered-by-vercel.svg)](https://vercel.com/?utm_source=threlte&utm_campaign=oss)
+
+---
+
+### License
+
+The MIT License (MIT). Please see the [License File](LICENSE.md) for more information.

src/bin.ts

@@ -164,3 +164,3 @@ #!/usr/bin/env node
       three: '^0.153.0',
-      '@threlte/core': 'next'
+      '@threlte/core': 'latest'
     },
@@ -174,10 +174,10 @@ scripts: {}
   if (options.threltePackages.includes('@threlte/extras')) {
-    threltePackageJson.devDependencies['@threlte/extras'] = 'next'
+    threltePackageJson.devDependencies['@threlte/extras'] = 'latest'
   }
   if (options.threltePackages.includes('@threlte/rapier')) {
-    threltePackageJson.devDependencies['@threlte/rapier'] = 'next'
+    threltePackageJson.devDependencies['@threlte/rapier'] = 'latest'
     threltePackageJson.devDependencies['@dimforge/rapier3d-compat'] = '^0.11.2'
   }
   if (options.threltePackages.includes('@threlte/theatre')) {
-    threltePackageJson.devDependencies['@threlte/theatre'] = 'next'
+    threltePackageJson.devDependencies['@threlte/theatre'] = 'latest'
     threltePackageJson.devDependencies['@theatre/core'] = '^0.6.1'
@@ -187,3 +187,3 @@ threltePackageJson.devDependencies['@theatre/studio'] = '^0.6.1'
   if (options.threltePackages.includes('model-pipeline')) {
-    threltePackageJson.devDependencies['@threlte/extras'] = 'next'
+    threltePackageJson.devDependencies['@threlte/extras'] = 'latest'
     threltePackageJson.scripts['model-pipeline:run'] = 'node scripts/model-pipeline.js'
@@ -286,7 +286,7 @@ }
     print(bold('✔ @threlte/extras'))
-    print(cyan('  https://next.threlte.xyz/docs/reference/extras/getting-started\n'))
+    print(cyan('  https://threlte.xyz/docs/reference/extras/getting-started\n'))
   }
   if (options.threltePackages.includes('@threlte/rapier')) {
     print(bold('✔ @threlte/rapier'))
-    print(cyan('  https://next.threlte.xyz/docs/reference/rapier/getting-started'))
+    print(cyan('  https://threlte.xyz/docs/reference/rapier/getting-started'))
     print(cyan('  https://rapier.rs/\n'))
@@ -296,3 +296,3 @@ }
     print(bold('✔ @threlte/theatre'))
-    print(cyan('  https://next.threlte.xyz/docs/reference/theatre/getting-started'))
+    print(cyan('  https://threlte.xyz/docs/reference/theatre/getting-started'))
     print(cyan('  https://www.theatrejs.com/\n'))
@@ -303,3 +303,3 @@ }
     print(cyan(`  ${pkgManager} run model-pipeline:run`))
-    print(cyan('  https://next.threlte.xyz/docs/reference/gltf/getting-started\n'))
+    print(cyan('  https://threlte.xyz/docs/reference/gltf/getting-started\n'))
   }
@@ -306,0 +306,0 @@ if (options.git) {

src/templates/model-pipeline+javascript/scripts/model-pipeline.js

@@ -88,3 +88,3 @@ import { execSync } from 'node:child_process'
   // run the command
-  const cmd = `npx @threlte/gltf@next ${path} ${formattedArgs}`
+  const cmd = `npx @threlte/gltf@latest ${path} ${formattedArgs}`
   try {
@@ -91,0 +91,0 @@ execSync(cmd, {

src/templates/model-pipeline+typescript/scripts/model-pipeline.js

@@ -88,3 +88,3 @@ import { execSync } from 'node:child_process'
   // run the command
-  const cmd = `npx @threlte/gltf@next ${path} ${formattedArgs}`
+  const cmd = `npx @threlte/gltf@latest ${path} ${formattedArgs}`
   try {
@@ -91,0 +91,0 @@ execSync(cmd, {

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1883259

increased by2326.82%

Number of package files

37

increased by2.78%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

62

increased by3000%

No dependency changes