A simple JavaScript module to parse the contents of Packwiz index files. https://packwizjs.csw.im/
Find a file
Renovate 671c21aeaa
All checks were successful
Actions / Build and Push Documentation (push) Successful in 15s
Pin dependencies (#7)
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| @​getmeli/cli | devDependencies | pin | [`^1.2.0` -> `1.2.0`](https://renovatebot.com/diffs/npm/@getmeli%2fcli/1.2.0/1.2.0) |
| [https://www.coastalcommits.com/actions/env](https://www.coastalcommits.com/actions/env) | action | pinDigest |  -> `1791216` |

Add the preset `:preserveSemverRanges` to your config if you don't want to pin your dependencies.

---

### 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 is behind base branch, or you tick the rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired.

---

 - [ ] <!-- 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/7
Co-authored-by: Renovate <renovate@coastalcommits.com>
Co-committed-by: Renovate <renovate@coastalcommits.com>
2025-02-09 15:05:10 -05:00
.forgejo/workflows Pin dependencies (#7) 2025-02-09 15:05:10 -05:00
packwiz add authors and description to the packwiz example pack 2025-02-09 09:59:14 -06:00
src make the filepath consistent between Packwiz.location and Packwiz.index.location 2025-02-09 13:38:42 -06:00
.editorconfig add src 2025-02-07 22:49:49 -06:00
.envrc add src 2025-02-07 22:49:49 -06:00
.gitignore switch to meli for documentation hosting 2025-02-09 14:00:39 -06:00
.neoconf.json add src 2025-02-07 22:49:49 -06:00
bun.lock Pin dependencies (#7) 2025-02-09 15:05:10 -05:00
eslint.config.js add src 2025-02-07 22:49:49 -06:00
flake.lock add src 2025-02-07 22:49:49 -06:00
flake.nix add src 2025-02-07 22:49:49 -06:00
LICENSE Initial commit 2025-02-07 21:23:32 -05:00
package.json Pin dependencies (#7) 2025-02-09 15:05:10 -05:00
README.md change documentation site link 2025-02-09 14:03:02 -06:00
renovate.json Add renovate.json 2025-02-08 12:41:18 +00:00
tsconfig.json add src 2025-02-07 22:49:49 -06:00
typedoc.json fix typo in typedoc.json 2025-02-09 14:02:58 -06:00

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
}