updates 16.3.7 → 16.4.0

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.
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
  `updates` is a CLI tool which checks for dependency updates. It is typically able to complete in less than a second. Supported dependencies are:
7
7
 
8
8
  - npm via `package.json`
9
- - pypi via `pyproject.toml`
9
+ - poetry via `pyproject.toml`
10
10
  - go via `go.mod` (checking only currently, disabled by default when directory is used)
11
11
 
12
12
  # Usage
@@ -45,27 +45,20 @@ The module uses global `fetch` under the hood. In Node.js HTTP proxies from envi
45
45
 
46
46
  ## Config File
47
47
 
48
- The config file is used to configure certain options of the module. CLI arguments have precedence over options in the config file, except for `include` and `exclude` options which are merged.
48
+ The config file is used to configure certain options of the module. It be placed as `updates.config.{js,ts,mjs,mts}` or `config/updates.config.{js,ts,mjs,mts}`, relative to `package.json`. For typescript to work in Node 22.6.0 and above, set `NODE_OPTIONS="--experimental-strip-types"` in your environment.
49
+
50
+ ```ts
51
+ import type {Config} from "updates";
49
52
 
50
- ```js
51
53
  export default {
52
54
  exclude: [
53
55
  "semver",
54
56
  "@vitejs/*",
55
57
  /^react(-dom)?$/,
56
58
  ],
57
- };
59
+ } satisfies Config;
58
60
  ```
59
61
 
60
- ### Config File Locations
61
-
62
- The config file can be placed in these locations, relative to `package.json`:
63
-
64
- - `updates.config.{js,ts,mjs,mts}`
65
- - `.config/updates.{js,ts,mjs,mts}`
66
-
67
- For typescript, your runtime needs to support it either natively or via a node loader.
68
-
69
62
  ### Config File Options
70
63
 
71
64
  - `include` *Array[String|Regexp]*: Array of dependencies to include
@@ -73,4 +66,6 @@ For typescript, your runtime needs to support it either natively or via a node l
73
66
  - `types` *Array[String]*: Array of dependency types
74
67
  - `registry` *String*: URL to npm registry
75
68
 
69
+ CLI arguments have precedence over options in the config file, except for `include` and `exclude` options which are merged.
70
+
76
71
  © [silverwind](https://github.com/silverwind), distributed under BSD licence
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env -S node --experimental-strip-types
2
+ export type Config = {
3
+ include?: Array<string | RegExp>;
4
+ exclude?: Array<string | RegExp>;
5
+ types?: Array<string>;
6
+ registry?: string;
7
+ };
8
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";AAoBA,MAAM,MAAM,MAAM,GAAG;IACnB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IACjC,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IACjC,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAA"}