@tahminator/pipeline 1.0.94 → 1.0.95

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 (2) hide show
  1. package/README.md +12 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -46,11 +46,15 @@ The setup action installs the CI package's dependencies with
46
46
  `GITHUB_SCRIPTS_DIR`:
47
47
 
48
48
  1. `src/internal/tsc.ts`: runs the package's TypeScript compiler with
49
- `--noEmit --project tsconfig.json`.
50
- 2. `src/internal/lint.ts`: runs the package's Oxlint with its
51
- `oxlint.config.ts`, using
52
- [native configuration loading](https://oxc.rs/docs/guide/usage/linter/config.html),
53
- then runs `oxfmt --check`. Both run even if Oxlint reports errors.
49
+ `--noEmit`, using TypeScript's normal config discovery.
50
+ 2. `src/internal/lintfmt.ts`: runs the package's Oxlint, then `oxfmt --check`.
51
+ Both run even if Oxlint reports errors.
52
+
53
+ The scripts do not require specific config filenames or pass config paths.
54
+ Each tool handles its own supported formats, discovery, defaults, and config errors.
55
+ For example, Oxlint supports
56
+ [JSON, JSONC, and TypeScript configs](https://oxc.rs/docs/guide/usage/linter/config.html),
57
+ and TypeScript searches for `tsconfig.json` in the current directory and its ancestors.
54
58
 
55
59
  All three tools resolve from the CI scripts package, not from the action's dependencies.
56
60
  Add them as devDependencies in that package and commit the updated `package.json`
@@ -60,7 +64,7 @@ and `bun.lock`:
60
64
  bun add --cwd .github/scripts -d typescript oxlint oxfmt
61
65
  ```
62
66
 
63
- Provide `tsconfig.json` and `oxlint.config.ts` in that directory. For example:
67
+ An optional Oxlint configuration could look like this:
64
68
 
65
69
  ```ts
66
70
  // .github/scripts/oxlint.config.ts
@@ -77,8 +81,8 @@ Oxfmt uses its native configuration discovery, or its defaults when no formatter
77
81
  config exists. To create a formatter config, run `bun run oxfmt --init` from the CI
78
82
  scripts package directory.
79
83
 
80
- Missing tools, launchers, or required configs produce actionable errors. Type,
81
- lint, or formatting errors fail the step; a failed typecheck stops before linting
84
+ Missing tools or launchers produce actionable errors. Config, type, lint, or
85
+ formatting errors fail the step; a failed typecheck stops before linting
82
86
  and formatting. No tools are downloaded by these scripts, no files are emitted or
83
87
  autofixed, and no tests run. `LINT_CI` remains disabled by default.
84
88
 
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "type": "module",
4
4
  "author": "Tahmid Ahmed",
5
5
  "description": "A collection of Bun shell scripts that can be re-used in various CICD pipelines.",
6
- "version": "1.0.94",
6
+ "version": "1.0.95",
7
7
  "repository": {
8
8
  "url": "git+https://github.com/tahminator/pipeline.git"
9
9
  },