create-stencil - npm Package Compare versions

Comparing version 3.4.0 to 3.5.0

package.json

 {
   "name": "create-stencil",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Quickly create a new stencil component project: npm init stencil",
@@ -74,5 +74,5 @@ "repository": {
   "volta": {
-    "node": "20.7.0",
+    "node": "20.8.0",
     "npm": "10.1.0"
   }
 }

README.md

@@ -103,7 +103,7 @@ # The create-stencil CLI
 
-In addition to the provided template options, users may choose to use one of their own templates.
-The template must by hosted on a public GitHub instance to use this feature.
+#### Custom Templates
+In addition to the provided template options, users may choose to use one of their own custom templates hosted on [GitHub.com](https://github.com).
 
-To use a custom starter template, provide the GitHub repository owner and repository name as your project's starter name, using the format `REPO_OWNER/REPO_NAME`.
-For example, to retrieve a template that is owned by the 'my-organization' that has the name 'my-stencil-template', the following may be used:
+To use a custom starter template, provide the GitHub repository owner and repository name as the starter name, using the format `REPO_OWNER/REPO_NAME`.
+For example, to retrieve a template that is owned by 'my-organization' that has the name 'my-stencil-template':
 ```
@@ -114,2 +114,4 @@ npm init stencil my-organization/my-stencil-template my-stencil-library
 
+This can be used in conjunction with [Self Hosted GitHub Instances](#stencilselfhostedurl) to use custom starter templates that live on a self-hosted GitHub instance.
+
 ### Additional Flags
@@ -145,2 +147,28 @@
 
+#### `stencil_self_hosted_url`
+
+In some scenarios, teams may find themselves working solely out of a self-hosted GitHub instance.
+
+Users wishing to point the create-stencil CLI at a GitHub instance other than [GitHub](https://github.com) have two options:
+
+1. Set `stencil_self_hosted_url` in your `.npmrc` file, like so:
+    ```
+    // .npmrc
+    stencil_self_hosted_url=https://your_self_hosted_github_repo.com/
+    ```
+
+    Using this option, the CLI can be called as such, automatically picking up the value in `stencil_self_hosted_url`:
+    ```
+    npm init stencil [starter] [project-name]
+    ```
+
+2. Set [`stencil_self_hosted_url`](#stencilselfhostedurl) at invocation time:
+    ```console
+    stencil_self_hosted_url=https://your_self_hosted_github_repo.com/ npm init stencil
+    ```
+   
+    When using this option, `stencil_self_hosted_url` must always be set every time the CLI is called.
+
+When both options are set, the value provided on the command line takes precedence over the value in your `.npmrc` file.
+
 ## Citations
@@ -147,0 +175,0 @@

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 2 instances in 1 package

Improved metrics

Total package byte prevSize

201556

increased by0.66%

Number of lines in readme file

181

increased by18.3%

Worsened metrics

Number of low supply chain risk alerts

15

increased by15.38%

No dependency changes