A simple JavaScript module to parse the contents of Packwiz index files.
https://packwizjs.csw.im/
Renovate
57875f00a6
Some checks failed
Actions / Build and Push Documentation (push) Failing after 10s
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [typedoc](https://typedoc.org) ([source](https://github.com/TypeStrong/TypeDoc)) | devDependencies | patch | [`0.27.6` -> `0.27.7`](https://renovatebot.com/diffs/npm/typedoc/0.27.6/0.27.7) | --- ### Release Notes <details> <summary>TypeStrong/TypeDoc (typedoc)</summary> ### [`v0.27.7`](https://github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0277-2025-02-09) [Compare Source](https://github.com/TypeStrong/TypeDoc/compare/v0.27.6...v0.27.7) ##### Features - `@includeCode` and `@inline` can now inject parts of files using region names or line numbers, [#​2816](https://github.com/TypeStrong/TypeDoc/issues/2816). - Introduced `ja` translation options, deprecated `jp` in favor of `ja`, [#​2843](https://github.com/TypeStrong/TypeDoc/issues/2843). - Improved TypeDoc's `--watch` option to support watching files not caught by TypeScript's watch mode, [#​2675](https://github.com/TypeStrong/TypeDoc/issues/2675). - The `@inline` tag now works in more places for generic types. - Visibility filters now consider individual signatures, [#​2846](https://github.com/TypeStrong/TypeDoc/issues/2846). ##### Bug Fixes - Fixed an issue where TypeDoc would incorrectly ignore type arguments in references, [#​2823](https://github.com/TypeStrong/TypeDoc/issues/2823). - Improved narrator support for labeling icons, [#​2832](https://github.com/TypeStrong/TypeDoc/issues/2832). - Fixed an issue with `@class` incorrectly handling mapped types, [#​2842](https://github.com/TypeStrong/TypeDoc/issues/2842). - TypeDoc will now consider symbols to be external only if all of their declarations are external so that declaration merged members with global symbols can be documented, [#​2844](https://github.com/TypeStrong/TypeDoc/issues/2844). - Fixed an issue where TypeDoc would constantly rebuild, [#​2844](https://github.com/TypeStrong/TypeDoc/issues/2844). - Fixed an issue where the dropdown arrow in the index group would not respect the state of the dropdown, [#​2845](https://github.com/TypeStrong/TypeDoc/issues/2845). ##### Thanks! - [@​pjeby](https://github.com/pjeby) - [@​shawninder](https://github.com/shawninder) - [@​tats-u](https://github.com/tats-u) - [@​XeroAlpha](https://github.com/XeroAlpha) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xNjMuMCIsInVwZGF0ZWRJblZlciI6IjM5LjE2My4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Reviewed-on: https://www.coastalcommits.com/GalacticFactory/PackwizJS/pulls/6 Co-authored-by: Renovate <renovate@coastalcommits.com> Co-committed-by: Renovate <renovate@coastalcommits.com> |
||
|---|---|---|
| .forgejo/workflows | ||
| packwiz | ||
| src | ||
| .editorconfig | ||
| .envrc | ||
| .gitignore | ||
| .neoconf.json | ||
| bun.lock | ||
| eslint.config.js | ||
| flake.lock | ||
| flake.nix | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| renovate.json | ||
| tsconfig.json | ||
| typedoc.json | ||
PackwizJS
A simple JavaScript module to parse the contents of Packwiz index files.
Installation
TODO
Usage
See the documentation for more information.
Basic Example
> import { parsePackwiz } from "packwizjs";
> const packwizFile = await parsePackwiz("./packwiz/pack.toml")
Packwiz {
location: Resource { path: 'packwiz/pack.toml' },
index: { // The index file is automatically parsed alongside the pack.toml file
location: Resource { path: 'packwiz/index.toml' },
hash: '6ce48b376540c840b9c2c1eaedbdf64f3b0e1203888ea644fc5d8fff66377c18',
hashFormat: 'sha256',
files: [
[IndexFileEntry],
[IndexFileEntry],
[IndexFileEntry],
[IndexFileEntry]
]
},
name: 'PackwizJS Testing Pack',
packFormat: 'packwiz:1.1.0',
authors: [ 'cswimr', 'GalacticFactory' ],
description: 'PackwizJS Testing Pack',
version: '1.0.0',
versions: {
minecraft: '1.21.4',
fabric: '0.16.10',
forge: undefined,
neoforge: undefined,
quilt: undefined,
liteloader: undefined
}
}
> await packwizFile.index.files[2].parse()
{
name: 'Fabric API',
filename: 'fabric-api-0.115.1+1.21.4.jar',
side: 'both',
provider: ModrinthProvider {
hash: 'd5e9f87679b5edc9786e651fc481f8861a9cf53ed381890a1cb5e129222d6c5fa99f06045007f8e1fba02da686cdb6db2d99b334a1d23881cb56dfa199932eea',
hashFormat: 'sha512',
url: Resource {
path: 'https://cdn.modrinth.com/data/P7dR8mSH/versions/UnrycCWP/fabric-api-0.115.1%2B1.21.4.jar'
},
modId: 'P7dR8mSH',
versionId: 'UnrycCWP'
},
isOptional: false,
isDefault: true,
description: undefined
}