tiged - npm Package Compare versions

Comparing version 2.12.0 to 2.12.1

bin.js

 #!/usr/bin/env node
-require('./dist/bin.js');
+require('./src/bin.js');

help.md

@@ -1,2 +0,2 @@
-# _degit_
+# _tiged_
 
@@ -52,10 +52,12 @@ Usage:
 
-  `--help`,    `-h`  Show this message
-  `--cache`,   `-c`  Only use local cache
-  `--force`,   `-f`  Allow non-empty destination directory
-  `--verbose`, `-v`  Extra logging
-  `--subgroup`, `-s` Use if repo is in a subroup (GitLab)
-  `--mode=`,   `-m=` Force the mode by which degit clones the repo
+  `--help`,    `-h`      Show this message
+  `--offline-mode`, `-o` Only use local cache. No fetching data online.
+  `--cache`,   `-c`      Same as above. Deprecated. Will be removed in v3.X
+  `--no-cache`,   `-n`   Do not use cache. Always fetch data online.
+  `--force`,   `-f`      Allow non-empty destination directory
+  `--verbose`, `-v`      Extra logging
+  `--subgroup`, `-s`     Use if repo is in a subroup (GitLab)
+  `--mode=`,   `-m=`     Force the mode by which degit clones the repo
                      Valid options are `tar` or `git` (uses SSH)
 
 See https://github.com/Rich-Harris/degit for more information

package.json

 {
 	"name": "tiged",
-	"version": "2.12.0",
+	"version": "2.12.1",
 	"engines": {
@@ -8,13 +8,10 @@ "node": ">=8.0.0"
 	"description": "Straightforward project scaffolding",
-	"main": "dist/index.js",
+	"main": "src/index.js",
 	"bin": {
-		"degit": "bin.js"
+		"degit": "bin.js",
+    "tiged": "bin.js"
 	},
 	"scripts": {
 		"lint": "eslint --color --ignore-path .gitignore .",
-		"dev": "npm run build -- --watch",
-		"build": "rimraf dist && rollup -c",
-		"test": "mocha",
-		"pretest": "npm run build",
-		"prepack": "npm run build"
+		"test": "mocha"
 	},
@@ -25,7 +22,3 @@ "repository": {
 	},
-	"keywords": [
-		"scaffolding",
-		"template",
-		"git"
-	],
+	"keywords": ["scaffolding", "template", "git"],
 	"author": "tiged",
@@ -40,9 +33,8 @@ "license": "MIT",
 		"enquirer": "2.3.6",
+		"fs-extra": "10.1.0",
 		"fuzzysearch": "1.0.3",
-		"home-or-tmp": "3.0.0",
 		"https-proxy-agent": "5.0.0",
 		"mri": "1.1.6",
 		"rimraf": "3.0.2",
-		"sander": "0.6.0",
-		"tar": "6.1.0",
+		"tar": "^6.1.11",
 		"tiny-glob": "0.2.8"
@@ -59,3 +51,3 @@ },
 		"lint-staged": "10.5.4",
-		"mocha": "8.3.0",
+		"mocha": "^10.0.0",
 		"prettier": "2.2.1",
@@ -66,6 +58,3 @@ "rollup": "2.38.5",
 	},
-	"files": [
-		"dist",
-		"help.md"
-	],
+	"files": ["src", "help.md"],
 	"husky": {
@@ -77,11 +66,5 @@ "hooks": {
 	"lint-staged": {
-		"*.{js}": [
-			"eslint --fix",
-			"git add"
-		],
-		"*.{js, json, yml, md}": [
-			"prettier --write",
-			"git add"
-		]
+		"*.{js}": ["eslint --fix", "git add"],
+		"*.{js, json, yml, md}": ["prettier --write", "git add"]
 	}
 }

README.md

@@ -1,2 +0,2 @@
-> Community driven fork of [degit](https://github.com/Rich-Harris/degit) because it isn't being maintained. We will be willing to give control of this repository to Rich Harris if he becomes active. *Rich has now merged the main branch fix. I'm monitoring the need of this fork. Currently this is still more fully featured*
+> This is a community driven fork of [degit](https://github.com/Rich-Harris/degit) because it isn't being maintained.
 
@@ -11,26 +11,6 @@ # tiged — straightforward project scaffolding
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
----
-### Why fork?
-* `degit` was last released over a year ago Feb 5, 2020, and Rich is not answering pull requests or issues there. He is probably very busy with Svelte and we love him for that.*Rich has now (April 1, 2021) merged the main branch fix. I'm monitoring the need of this fork. Currently this fork is still more fully featured*
-* We want pull requests merged. E.g. like automatically working with `main` or other default branch (has been merged!).
-* Update dependencies.
-* Hopefully get multiple active maintainers.
 
-### What has been fixed?
-* Works with `main` or any default branch automatically. [#243](https://github.com/Rich-Harris/degit/pull/243)
-* `--mode=git` with private repos now work on Windows [#191](https://github.com/Rich-Harris/degit/pull/191).
-* `degit --help` now works. Previously it would crash instead of displaying help.md contents. [#179](https://github.com/Rich-Harris/degit/pull/179)
-* `--mode=git` is now faster. [#171](https://github.com/Rich-Harris/degit/pull/171)
-* Github Actions CI tests working. Added Github Actions badge and removed old CI badges.
-* Added support for privately hosted git repositories ([#10](https://github.com/tiged/tiged/pull/10))
-* GitLab works again. [#18](https://github.com/tiged/tiged/pull/18)
-* Subdir works in `--mode=git` [#19](https://github.com/tiged/tiged/pull/19)
-* Subgroups work in GitLab [#24](https://github.com/tiged/tiged/pull/24)
 
-**It might be time to move on.**
----
-**degit** makes copies of git repositories. When you run `degit some-user/some-repo`, it will find the latest commit on https://github.com/some-user/some-repo and download the associated tar file to `~/.degit/some-user/some-repo/commithash.tar.gz` if it doesn't already exist locally. (This is much quicker than using `git clone`, because you're not downloading the entire git history.)
+**tiged** makes copies of git repositories. When you run `tiged some-user/some-repo` or (for backward compatibility) `degit some-user/some-repo`, it will find the latest commit on https://github.com/some-user/some-repo and download the associated tar file to `~/.degit/some-user/some-repo/commithash.tar.gz` if it doesn't already exist locally. (This is much quicker than using `git clone`, because you're not downloading the entire git history.)
 
-_Requires Node 8 or above, because `async` and `await` are the cat's pyjamas_
-
 ## Installation
@@ -47,13 +27,13 @@
 
-> The run command stays as before, degit and not tiged. So no automated scripts break and people are used to the good old name.
+> You can use tiged or degit as the command. So no automated scripts break if you swap degit for tiged.
 
-The simplest use of degit is to download the master branch of a repo from GitHub to the current working directory:
+The simplest use of tiged is to download the main branch of a repo from GitHub to the current working directory:
 
 ```bash
-degit user/repo
+tiged user/repo
 
 # these commands are equivalent
-degit github:user/repo
-degit [e-mail]:user/repo
-degit https://github.com/user/repo
+tiged github:user/repo
+tiged [e-mail]:user/repo
+tiged https://github.com/user/repo
 ```
@@ -65,15 +45,15 @@
 # download from GitLab
-degit gitlab:user/repo
-degit [e-mail]:user/repo
-degit https://gitlab.com/user/repo
+tiged gitlab:user/repo
+tiged [e-mail]:user/repo
+tiged https://gitlab.com/user/repo
 
 # download from BitBucket
-degit bitbucket:user/repo
-degit [e-mail]:user/repo
-degit https://bitbucket.org/user/repo
+tiged bitbucket:user/repo
+tiged [e-mail]:user/repo
+tiged https://bitbucket.org/user/repo
 
 # download from Sourcehut
-degit git.sr.ht/user/repo
-degit [e-mail]:user/repo
-degit https://git.sr.ht/user/repo
+tiged git.sr.ht/user/repo
+tiged [e-mail]:user/repo
+tiged https://git.sr.ht/user/repo
 ```
@@ -84,5 +64,5 @@
 ```bash
-degit user/repo#dev       # branch
-degit user/repo#v1.2.3    # release tag
-degit user/repo#1234abcd  # commit hash
+tiged user/repo#dev       # branch
+tiged user/repo#v1.2.3    # release tag
+tiged user/repo#1234abcd  # commit hash
 ```
@@ -95,5 +75,11 @@
 ```bash
-degit user/repo my-new-project
+tiged user/repo my-new-project
 ```
 
+### Disable cache
+Normally tiged caches tar.gz of the repo for future use. This is sometimes unwanted (e.g. scroll down for known bug)
+```bash
+tiged --no-cache user/repo
+```
+
 ### Specify a subdirectory
@@ -104,3 +90,3 @@
 ```bash
-degit user/repo/subdirectory
+tiged user/repo/subdirectory
 ```
@@ -113,4 +99,4 @@
 ```bash
-degit --subgroup https://gitlab.com/group-test-repo/subgroup-test-repo/test-repo my-dir
-degit -s https://gitlab.com/group-test-repo/subgroup-test-repo/test-repo my-dir
+tiged --subgroup https://gitlab.com/group-test-repo/subgroup-test-repo/test-repo my-dir
+tiged -s https://gitlab.com/group-test-repo/subgroup-test-repo/test-repo my-dir
 ```
@@ -121,3 +107,3 @@
 ```bash
-degit --subgroup https://gitlab.com/group-test-repo/subgroup-test-repo/test-repo --sub-directory subdir1 my-dir
+tiged --subgroup https://gitlab.com/group-test-repo/subgroup-test-repo/test-repo --sub-directory subdir1 my-dir
 ```
@@ -127,7 +113,7 @@
 
-If you have an `https_proxy` environment variable, Degit will use it.
+If you have an `https_proxy` environment variable, Tiged will use it.
 
 ### Private repositories
 
-Private repos can be cloned by specifying `--mode=git` (the default is `tar`). In this mode, Degit will use `git` under the hood. It's much slower than fetching a tarball, which is why it's not the default.
+Private repos can be cloned by specifying `--mode=git` (the default is `tar`). In this mode, Tiged will use `git` under the hood. It's much slower than fetching a tarball, which is why it's not the default.
 
@@ -139,3 +125,3 @@ Note: this clones over SSH, not HTTPS.
 ```bash
-degit --help
+tiged --help
 ```
@@ -149,3 +135,3 @@
 - Caching and offline support (if you already have a `.tar.gz` file for a specific commit, you don't need to fetch it again).
-- Less to type (`degit user/repo` instead of `git clone --depth 1 [e-mail]:user/repo`)
+- Less to type (`tiged user/repo` instead of `git clone --depth 1 [e-mail]:user/repo`)
 - Composability via [actions](#actions)
@@ -156,11 +142,11 @@ - Future capabilities — [interactive mode](https://github.com/Rich-Harris/degit/issues/4), [friendly onboarding and postinstall scripts](https://github.com/Rich-Harris/degit/issues/6)
 
-You can also use degit inside a Node script:
+You can also use tiged inside a Node script:
 
 ```js
-const degit = require('degit');
+const tiged = require('tiged');
 
-const emitter = degit('user/repo', {
+const emitter = tiged('user/repo', {
 	cache: true,
 	force: true,
-	verbose: true,
+	verbose: true
 });
@@ -209,2 +195,29 @@
 
+## Known bugs and workarounds
+
+- `zlib: unexpected end of file`: this is solved by using option `--no-cache` or clearing the cache folder (`rm -rf ~/.degit`); more details in [#45](https://github.com/tiged/tiged/issues/45)
+
+### Why I forked degit?
+
+- `degit` was last released over a year ago Feb 5, 2020, and Rich is not answering pull requests or issues there. He is probably very busy with Svelte and we love him for that._Rich has now (April 1, 2021) merged the main branch fix. Regardless currently this fork is still more fully featured and will continue to be developed._
+- We want pull requests merged. E.g. like automatically working with `main` or other default branch (has been merged!).
+- Update dependencies.
+- Hopefully get multiple active maintainers.
+
+### What has been fixed?
+
+- Works with `main` or any default branch automatically. [#243](https://github.com/Rich-Harris/degit/pull/243)
+- `--mode=git` with private repos now work on Windows [#191](https://github.com/Rich-Harris/degit/pull/191).
+- `degit --help` now works. Previously it would crash instead of displaying help.md contents. [#179](https://github.com/Rich-Harris/degit/pull/179)
+- `--mode=git` is now faster. [#171](https://github.com/Rich-Harris/degit/pull/171)
+- Github Actions CI tests working. Added Github Actions badge and removed old CI badges.
+- Added support for privately hosted git repositories ([#10](https://github.com/tiged/tiged/pull/10))
+- GitLab works again. [#18](https://github.com/tiged/tiged/pull/18)
+- Subdir works in `--mode=git` [#19](https://github.com/tiged/tiged/pull/19)
+- Subgroups work in GitLab [#24](https://github.com/tiged/tiged/pull/24)
+- Hashes work with git mode [#34](https://github.com/tiged/tiged/pull/34)
+- Using full async + cjs (no build needed) [#41](https://github.com/tiged/tiged/pull/41)
+- Option to not use cache [#36](https://github.com/tiged/tiged/issue/36)
+
+#### It might be time to move on.
 ## See also
@@ -211,0 +224,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

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

Found 1 instance in 1 package

Improved metrics

Dependency count

9

decreased by-10%

Number of lines in readme file

218

increased by6.34%

Number of low supply chain risk alerts

5

decreased by-16.67%

Number of medium supply chain risk alerts

7

decreased by-41.67%

Worsened metrics

Total package byte prevSize

30187

decreased by-75.06%

Number of package files

8

decreased by-33.33%

Lines of code

689

decreased by-35.31%

Number of medium maintenance alerts

1

increased byInfinity%

Dependency changes

• + Addedfs-extra@10.1.0

• + Addedfs-extra@10.1.0(transitive)

• + Addedjsonfile@6.1.0(transitive)

• + Addedminipass@5.0.0(transitive)

• + Addedtar@6.2.1(transitive)

• + Addeduniversalify@2.0.1(transitive)

• - Removedhome-or-tmp@3.0.0

• - Removedsander@0.6.0

• - Removedhome-or-tmp@3.0.0(transitive)

• - Removedminimist@1.2.8(transitive)

• - Removedmkdirp@0.5.6(transitive)

• - Removedrimraf@2.7.1(transitive)

• - Removedsander@0.6.0(transitive)

• - Removedtar@6.1.0(transitive)

• Updatedtar@^6.1.11