syncpack-darwin-arm64 14.0.0-alpha.3 → 14.0.0-alpha.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +138 -20
  2. package/bin/syncpack +0 -0
  3. package/package.json +5 -2
package/README.md CHANGED
@@ -1,54 +1,172 @@
1
1
  # syncpack
2
2
 
3
3
  <p align="center">
4
- <img src="https://jamiemason.github.io/syncpack/logo.svg" width="200" height="179" alt="">
4
+ <img src="https://jamiemason.github.io/syncpack/logo.svg" width="134" height="120" alt="">
5
5
  <br>Consistent dependency versions in large JavaScript Monorepos.
6
6
  <br><a href="https://jamiemason.github.io/syncpack">https://jamiemason.github.io/syncpack</a>
7
7
  </p>
8
8
 
9
+ > [!NOTE]
10
+ > This is the README for v14-alpha, a Rust rewrite which is due to replace [`v13.x.x`](https://github.com/JamieMason/syncpack/tree/13.x.x?tab=readme-ov-file#syncpack)
11
+
9
12
  ## Installation
10
13
 
11
14
  ```bash
12
- npm install --save-dev syncpack
15
+ npm install --save-dev syncpack@alpha
13
16
  ```
14
17
 
18
+ ## Guides
19
+
20
+ - [Getting Started](https://jamiemason.github.io/syncpack/)
21
+ - [Migrate to 14](https://jamiemason.github.io/syncpack/guide/migrate-v14/)
22
+
15
23
  ## Commands
16
24
 
17
- ### [fix-mismatches](https://jamiemason.github.io/syncpack/command/fix-mismatches)
25
+ > All command line options can be combined to target packages and dependencies in multiple ways.
18
26
 
19
- Ensure that multiple packages requiring the same dependency define the same version, so that every package requires eg. `react@16.4.2`, instead of a combination of `react@16.4.2`, `react@0.15.9`, and `react@16.0.0`.
27
+ ### [lint](https://jamiemason.github.io/syncpack/command/lint)
20
28
 
21
- ### [format](https://jamiemason.github.io/syncpack/command/format)
29
+ Ensure that multiple packages requiring the same dependency define the same version, so that every package requires eg. `react@17.0.2`, instead of a combination of `react@17.0.2`, `react@16.8.3`, and `react@16.14.0`.
22
30
 
23
- Organise package.json files according to a conventional format, where fields appear in a predictable order and nested fields are ordered alphabetically. Shorthand properties are used where available, such as the `"repository"` and `"bugs"` fields.
31
+ #### Examples
24
32
 
25
- ### [lint](https://jamiemason.github.io/syncpack/command/lint)
33
+ ```bash
34
+ # Find all issues in "dependencies" or "devDependencies"
35
+ syncpack lint --dependency-types prod,dev
36
+ # Only lint issues in "react" specifically
37
+ syncpack lint --dependencies react
38
+ # Look for issues in dependencies containing "react" in the name
39
+ syncpack lint --dependencies '**react**'
40
+ # Find issues in scoped packages only
41
+ syncpack lint --dependencies '@types/**'
42
+ # Find issues everywhere except "peerDependencies"
43
+ syncpack lint --dependency-types '!peer'
44
+ # Only look for issues where an exact version is used (eg "1.2.3")
45
+ syncpack lint --specifier-types exact
46
+ # Sort dependencies by how many times they are used
47
+ syncpack lint --sort count
48
+ # See more examples
49
+ syncpack lint --help
50
+ # See a short summary of options
51
+ syncpack lint -h
52
+ ```
26
53
 
27
- Lint all versions and ranges and exit with 0 or 1 based on whether all files match your Syncpack configuration file.
54
+ ### [fix](https://jamiemason.github.io/syncpack/command/fix)
28
55
 
29
- ### [lint-semver-ranges](https://jamiemason.github.io/syncpack/command/lint-semver-ranges)
56
+ Fix every autofixable issue found by `syncpack lint`.
30
57
 
31
- Check whether dependency versions used within "dependencies", "devDependencies", etc follow a consistent format.
58
+ #### Examples
32
59
 
33
- ### [list](https://jamiemason.github.io/syncpack/command/list)
60
+ ```bash
61
+ # Only fix issues in dependencies and devDependencies
62
+ syncpack fix --dependency-types prod,dev
63
+ # Only fix inconsistencies with exact versions (eg "1.2.3")
64
+ syncpack fix --specifier-types exact
65
+ # Only fix issues in "react" specifically
66
+ syncpack fix --dependencies react
67
+ # See more examples
68
+ syncpack fix --help
69
+ # See a short summary of options
70
+ syncpack fix -h
71
+ ```
72
+
73
+ ### [update](https://jamiemason.github.io/syncpack/command/update)
74
+
75
+ Update packages to the latest versions from the npm registry, wherever they are in your monorepo.<br/>Semver range preferences are preserved when updating.
76
+
77
+ #### Examples
34
78
 
35
- List all dependencies required by your packages.
79
+ ```bash
80
+ # Accept any update in latest (x.x.x)
81
+ syncpack update --target latest
82
+ # Only update minor versions (1.x.x)
83
+ syncpack update --target minor
84
+ # Only update patch versions (1.2.x)
85
+ syncpack update --target patch
86
+ # Check for outdated dependencies in one package
87
+ syncpack update --check --source 'packages/pingu/package.json'
88
+ # Update dependencies and devDependencies in the whole monorepo
89
+ syncpack update --dependency-types dev,prod
90
+ # Only update dependencies with a semver range specifier (^, ~, etc.)
91
+ syncpack update --specifier-types range
92
+ # Update dependencies where name exactly matches 'react'
93
+ syncpack update --dependencies 'react'
94
+ # Update dependencies where name contains 'react'
95
+ syncpack update --dependencies '**react**'
96
+ # Update dependencies with the '@aws-sdk' scope
97
+ syncpack update --dependencies '@aws-sdk/**'
98
+ # See more examples
99
+ syncpack update --help
100
+ # See a short summary of options
101
+ syncpack update -h
102
+ ```
36
103
 
37
- ### [list-mismatches](https://jamiemason.github.io/syncpack/command/list-mismatches)
104
+ ### [format](https://jamiemason.github.io/syncpack/command/format)
38
105
 
39
- List dependencies which are required by multiple packages, where the version is not the same across every package.
106
+ Organise package.json files according to a conventional format, where fields appear in a predictable order and nested fields are ordered alphabetically. Shorthand properties are used where available, such as the `"repository"` and `"bugs"` fields.
40
107
 
41
- ### [prompt](https://jamiemason.github.io/syncpack/command/prompt)
108
+ #### Examples
42
109
 
43
- Displays a series of prompts to fix mismatches which syncpack cannot fix automatically.
110
+ ```bash
111
+ # Fix every formatting issue in the monorepo
112
+ syncpack format
113
+ # List all formatting issues in the monorepo
114
+ syncpack format --check
115
+ # Check the formatting of one package
116
+ syncpack format --check --source 'packages/pingu/package.json'
117
+ # See more examples
118
+ syncpack format --help
119
+ # See a short summary of options
120
+ syncpack format -h
121
+ ```
44
122
 
45
- ### [set-semver-ranges](https://jamiemason.github.io/syncpack/command/set-semver-ranges)
123
+ ### [list](https://jamiemason.github.io/syncpack/command/list)
46
124
 
47
- Ensure dependency versions used within `"dependencies"`, `"devDependencies"` etc follow a consistent format.
125
+ Query and inspect all dependencies in your project, both valid and invalid.
48
126
 
49
- ### [update](https://jamiemason.github.io/syncpack/command/update)
127
+ #### Examples
50
128
 
51
- Interactively update packages to the latest versions from the npm registry, wherever they are in your monorepo. You can update every dependency, just dev/peer/prod dependencies, just packages which match a name filter, and more.
129
+ ```bash
130
+ # Sort dependencies by how many times they are used
131
+ syncpack list --sort count
132
+ # Show every instance of each dependency, not just their names
133
+ syncpack list --show instances
134
+ # Show dependencies ignored in your syncpack config
135
+ syncpack list --show ignored
136
+ # Show highest level of detail
137
+ syncpack list --show all
138
+ # Choose only some values
139
+ syncpack list --show hints,statuses
140
+ # List all "peerDependencies"
141
+ syncpack list --dependency-types peer
142
+ # List all types packages
143
+ syncpack list --dependencies '@types/**'
144
+ # List instances of an exact version being used as a peer dependency
145
+ syncpack list --specifier-types exact --show instances --dependency-types peer
146
+ # See more examples
147
+ syncpack list --help
148
+ # See a short summary of options
149
+ syncpack list -h
150
+ ```
151
+
152
+ ### [json](https://jamiemason.github.io/syncpack/command/json)
153
+
154
+ Output the state of every instance of every dependency as a JSON object, one per line. This command is best used with tools like [`jq`](https://jqlang.org/) for filtering and processing.
155
+
156
+ #### Examples
157
+
158
+ ```bash
159
+ # Output all dependencies as JSON
160
+ syncpack json
161
+ # Output only AWS SDK dependencies
162
+ syncpack json --dependencies '@aws-sdk/**'
163
+ # Count dependencies by type
164
+ syncpack json | jq -r '.dependencyType' | sort | uniq -c
165
+ # See more examples
166
+ syncpack json --help
167
+ # See a short summary of options
168
+ syncpack json -h
169
+ ```
52
170
 
53
171
  ## Badges
54
172
 
package/bin/syncpack CHANGED
Binary file
package/package.json CHANGED
@@ -1,13 +1,16 @@
1
1
  {
2
2
  "name": "syncpack-darwin-arm64",
3
3
  "description": "Rust Binary for darwin arm64",
4
- "version": "14.0.0-alpha.3",
4
+ "version": "14.0.0-alpha.31",
5
5
  "author": "Jamie Mason <jamie@foldleft.io> (https://github.com/JamieMason)",
6
6
  "bugs": "https://github.com/JamieMason/syncpack/issues",
7
7
  "funding": "https://github.com/sponsors/JamieMason",
8
8
  "homepage": "https://github.com/JamieMason/syncpack#readme",
9
9
  "license": "MIT",
10
- "repository": "JamieMason/syncpack",
10
+ "repository": {
11
+ "type": "git",
12
+ "url": "git+https://github.com/JamieMason/syncpack.git"
13
+ },
11
14
  "os": [
12
15
  "darwin"
13
16
  ],