syncpack-linux-x64 14.0.0-alpha.4 → 14.0.0-alpha.40

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 +140 -20
  2. package/bin/syncpack +0 -0
  3. package/package.json +5 -2
package/README.md CHANGED
@@ -1,54 +1,174 @@
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
+ Syncpack is used by [AWS](https://github.com/aws/aws-pdk), [Cloudflare](https://github.com/cloudflare/mcp-server-cloudflare), [DataDog](https://github.com/DataDog/datadog-ci), [Electron](https://github.com/electron/forge), [GoDaddy](https://github.com/godaddy/gasket), [LiveStore](https://github.com/livestorejs/livestore), [Lottie](https://github.com/LottieFiles/dotlottie-web), [Microsoft](https://github.com/microsoft/fluentui), [PostHog](https://github.com/PostHog/posthog), [Qwik](https://github.com/QwikDev/qwik), [Raycast](https://github.com/raycast/extensions), [Salesforce](https://github.com/SalesforceCommerceCloud/pwa-kit), [TopTal](https://github.com/toptal/picasso), [Vercel](https://github.com/vercel/vercel), [VoltAgent](https://github.com/VoltAgent/voltagent), [WooCommerce](https://github.com/woocommerce/woocommerce) and others.
10
+
11
+ > [!NOTE]
12
+ > 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)
13
+
9
14
  ## Installation
10
15
 
11
16
  ```bash
12
- npm install --save-dev syncpack
17
+ npm install --save-dev syncpack@alpha
13
18
  ```
14
19
 
20
+ ## Guides
21
+
22
+ - [Getting Started](https://jamiemason.github.io/syncpack/)
23
+ - [Migrate to 14](https://jamiemason.github.io/syncpack/guide/migrate-v14/)
24
+
15
25
  ## Commands
16
26
 
17
- ### [fix-mismatches](https://jamiemason.github.io/syncpack/command/fix-mismatches)
27
+ > All command line options can be combined to target packages and dependencies in multiple ways.
18
28
 
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`.
29
+ ### [lint](https://jamiemason.github.io/syncpack/command/lint)
20
30
 
21
- ### [format](https://jamiemason.github.io/syncpack/command/format)
31
+ 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
32
 
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.
33
+ #### Examples
24
34
 
25
- ### [lint](https://jamiemason.github.io/syncpack/command/lint)
35
+ ```bash
36
+ # Find all issues in "dependencies" or "devDependencies"
37
+ syncpack lint --dependency-types prod,dev
38
+ # Only lint issues in "react" specifically
39
+ syncpack lint --dependencies react
40
+ # Look for issues in dependencies containing "react" in the name
41
+ syncpack lint --dependencies '**react**'
42
+ # Find issues in scoped packages only
43
+ syncpack lint --dependencies '@types/**'
44
+ # Find issues everywhere except "peerDependencies"
45
+ syncpack lint --dependency-types '!peer'
46
+ # Only look for issues where an exact version is used (eg "1.2.3")
47
+ syncpack lint --specifier-types exact
48
+ # Sort dependencies by how many times they are used
49
+ syncpack lint --sort count
50
+ # See more examples
51
+ syncpack lint --help
52
+ # See a short summary of options
53
+ syncpack lint -h
54
+ ```
26
55
 
27
- Lint all versions and ranges and exit with 0 or 1 based on whether all files match your Syncpack configuration file.
56
+ ### [fix](https://jamiemason.github.io/syncpack/command/fix)
28
57
 
29
- ### [lint-semver-ranges](https://jamiemason.github.io/syncpack/command/lint-semver-ranges)
58
+ Fix every autofixable issue found by `syncpack lint`.
30
59
 
31
- Check whether dependency versions used within "dependencies", "devDependencies", etc follow a consistent format.
60
+ #### Examples
32
61
 
33
- ### [list](https://jamiemason.github.io/syncpack/command/list)
62
+ ```bash
63
+ # Only fix issues in dependencies and devDependencies
64
+ syncpack fix --dependency-types prod,dev
65
+ # Only fix inconsistencies with exact versions (eg "1.2.3")
66
+ syncpack fix --specifier-types exact
67
+ # Only fix issues in "react" specifically
68
+ syncpack fix --dependencies react
69
+ # See more examples
70
+ syncpack fix --help
71
+ # See a short summary of options
72
+ syncpack fix -h
73
+ ```
34
74
 
35
- List all dependencies required by your packages.
75
+ ### [update](https://jamiemason.github.io/syncpack/command/update)
36
76
 
37
- ### [list-mismatches](https://jamiemason.github.io/syncpack/command/list-mismatches)
77
+ Update packages to the latest versions from the npm registry, wherever they are in your monorepo.<br/>Semver range preferences are preserved when updating.
38
78
 
39
- List dependencies which are required by multiple packages, where the version is not the same across every package.
79
+ #### Examples
40
80
 
41
- ### [prompt](https://jamiemason.github.io/syncpack/command/prompt)
81
+ ```bash
82
+ # Accept any update in latest (x.x.x)
83
+ syncpack update --target latest
84
+ # Only update minor versions (1.x.x)
85
+ syncpack update --target minor
86
+ # Only update patch versions (1.2.x)
87
+ syncpack update --target patch
88
+ # Check for outdated dependencies in one package
89
+ syncpack update --check --source 'packages/pingu/package.json'
90
+ # Update dependencies and devDependencies in the whole monorepo
91
+ syncpack update --dependency-types dev,prod
92
+ # Only update dependencies with a semver range specifier (^, ~, etc.)
93
+ syncpack update --specifier-types range
94
+ # Update dependencies where name exactly matches 'react'
95
+ syncpack update --dependencies 'react'
96
+ # Update dependencies where name contains 'react'
97
+ syncpack update --dependencies '**react**'
98
+ # Update dependencies with the '@aws-sdk' scope
99
+ syncpack update --dependencies '@aws-sdk/**'
100
+ # See more examples
101
+ syncpack update --help
102
+ # See a short summary of options
103
+ syncpack update -h
104
+ ```
42
105
 
43
- Displays a series of prompts to fix mismatches which syncpack cannot fix automatically.
106
+ ### [format](https://jamiemason.github.io/syncpack/command/format)
44
107
 
45
- ### [set-semver-ranges](https://jamiemason.github.io/syncpack/command/set-semver-ranges)
108
+ 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.
46
109
 
47
- Ensure dependency versions used within `"dependencies"`, `"devDependencies"` etc follow a consistent format.
110
+ #### Examples
48
111
 
49
- ### [update](https://jamiemason.github.io/syncpack/command/update)
112
+ ```bash
113
+ # Fix every formatting issue in the monorepo
114
+ syncpack format
115
+ # List all formatting issues in the monorepo
116
+ syncpack format --check
117
+ # Check the formatting of one package
118
+ syncpack format --check --source 'packages/pingu/package.json'
119
+ # See more examples
120
+ syncpack format --help
121
+ # See a short summary of options
122
+ syncpack format -h
123
+ ```
124
+
125
+ ### [list](https://jamiemason.github.io/syncpack/command/list)
126
+
127
+ Query and inspect all dependencies in your project, both valid and invalid.
128
+
129
+ #### Examples
50
130
 
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.
131
+ ```bash
132
+ # Sort dependencies by how many times they are used
133
+ syncpack list --sort count
134
+ # Show every instance of each dependency, not just their names
135
+ syncpack list --show instances
136
+ # Show dependencies ignored in your syncpack config
137
+ syncpack list --show ignored
138
+ # Show highest level of detail
139
+ syncpack list --show all
140
+ # Choose only some values
141
+ syncpack list --show hints,statuses
142
+ # List all "peerDependencies"
143
+ syncpack list --dependency-types peer
144
+ # List all types packages
145
+ syncpack list --dependencies '@types/**'
146
+ # List instances of an exact version being used as a peer dependency
147
+ syncpack list --specifier-types exact --show instances --dependency-types peer
148
+ # See more examples
149
+ syncpack list --help
150
+ # See a short summary of options
151
+ syncpack list -h
152
+ ```
153
+
154
+ ### [json](https://jamiemason.github.io/syncpack/command/json)
155
+
156
+ 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.
157
+
158
+ #### Examples
159
+
160
+ ```bash
161
+ # Output all dependencies as JSON
162
+ syncpack json
163
+ # Output only AWS SDK dependencies
164
+ syncpack json --dependencies '@aws-sdk/**'
165
+ # Count dependencies by type
166
+ syncpack json | jq -r '.dependencyType' | sort | uniq -c
167
+ # See more examples
168
+ syncpack json --help
169
+ # See a short summary of options
170
+ syncpack json -h
171
+ ```
52
172
 
53
173
  ## Badges
54
174
 
package/bin/syncpack CHANGED
Binary file
package/package.json CHANGED
@@ -1,13 +1,16 @@
1
1
  {
2
2
  "name": "syncpack-linux-x64",
3
3
  "description": "Rust Binary for linux x64",
4
- "version": "14.0.0-alpha.4",
4
+ "version": "14.0.0-alpha.40",
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
  "linux"
13
16
  ],