8839075805
Implements Phases 1-8 of the TFTSR implementation plan. Rust backend (Tauri 2.x, src-tauri/): - Multi-provider AI: OpenAI-compatible, Anthropic, Gemini, Mistral, Ollama - PII detection engine: 11 regex patterns with overlap resolution - SQLCipher AES-256 encrypted database with 10 versioned migrations - 28 Tauri IPC commands for triage, analysis, document, and system ops - Ollama: hardware probe, model recommendations, pull/delete with events - RCA and blameless post-mortem Markdown document generators - PDF export via printpdf - Audit log: SHA-256 hash of every external data send - Integration stubs for Confluence, ServiceNow, Azure DevOps (v0.2) Frontend (React 18 + TypeScript + Vite, src/): - 9 pages: full triage workflow NewIssue→LogUpload→Triage→Resolution→RCA→Postmortem→History+Settings - 7 components: ChatWindow, TriageProgress, PiiDiffViewer, DocEditor, HardwareReport, ModelSelector, UI primitives - 3 Zustand stores: session, settings (persisted), history - Type-safe tauriCommands.ts matching Rust backend types exactly - 8 IT domain system prompts (Linux, Windows, Network, K8s, DB, Virt, HW, Obs) DevOps: - .woodpecker/test.yml: rustfmt, clippy, cargo test, tsc, vitest on every push - .woodpecker/release.yml: linux/amd64 + linux/arm64 builds, Gogs release upload Verified: - cargo check: zero errors - tsc --noEmit: zero errors - vitest run: 13/13 unit tests passing Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
84 lines
2.0 KiB
Markdown
84 lines
2.0 KiB
Markdown
# read-pkg
|
|
|
|
> Read a package.json file
|
|
|
|
## Why
|
|
|
|
- [Throws more helpful JSON errors](https://github.com/sindresorhus/parse-json)
|
|
- [Normalizes the data](https://github.com/npm/normalize-package-data#what-normalization-currently-entails)
|
|
|
|
## Install
|
|
|
|
```sh
|
|
npm install read-pkg
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
import {readPackage} from 'read-pkg';
|
|
|
|
console.log(await readPackage());
|
|
//=> {name: 'read-pkg', …}
|
|
|
|
console.log(await readPackage({cwd: 'some-other-directory'}));
|
|
//=> {name: 'unicorn', …}
|
|
```
|
|
|
|
## API
|
|
|
|
### readPackage(options?)
|
|
|
|
Returns a `Promise<object>` with the parsed JSON.
|
|
|
|
### readPackageSync(options?)
|
|
|
|
Returns the parsed JSON.
|
|
|
|
#### options
|
|
|
|
Type: `object`
|
|
|
|
##### cwd
|
|
|
|
Type: `URL | string`\
|
|
Default: `process.cwd()`
|
|
|
|
Current working directory.
|
|
|
|
##### normalize
|
|
|
|
Type: `boolean`\
|
|
Default: `true`
|
|
|
|
[Normalize](https://github.com/npm/normalize-package-data#what-normalization-currently-entails) the package data.
|
|
|
|
### parsePackage(packageFile, options?)
|
|
|
|
Parses an object or string into JSON.
|
|
|
|
Note: `packageFile` is cloned using [`structuredClone`](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone) to prevent modification to the input object. This function is available from Node.js 18 on. In environments without `structuredClone` (such as Node.js 16), a shallow spread is used instead, which can cause deep properties of the object to be modified. Consider cloning the object before using `parsePackage` if that's the case.
|
|
|
|
#### packageFile
|
|
|
|
Type: `object | string`
|
|
|
|
An object or a stringified object to be parsed as a package.json.
|
|
|
|
#### options
|
|
|
|
Type: `object`
|
|
|
|
##### normalize
|
|
|
|
Type: `boolean`\
|
|
Default: `true`
|
|
|
|
[Normalize](https://github.com/npm/normalize-package-data#what-normalization-currently-entails) the package data.
|
|
|
|
## Related
|
|
|
|
- [read-pkg-up](https://github.com/sindresorhus/read-pkg-up) - Read the closest package.json file
|
|
- [write-pkg](https://github.com/sindresorhus/write-pkg) - Write a `package.json` file
|
|
- [load-json-file](https://github.com/sindresorhus/load-json-file) - Read and parse a JSON file
|