Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ifiokjr/package_json_schema
A PackageJson struct for your rust code.
https://github.com/ifiokjr/package_json_schema
json npm package
Last synced: about 2 months ago
JSON representation
A PackageJson struct for your rust code.
- Host: GitHub
- URL: https://github.com/ifiokjr/package_json_schema
- Owner: ifiokjr
- License: unlicense
- Created: 2022-08-01T14:58:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T13:43:30.000Z (4 months ago)
- Last Synced: 2024-10-31T12:14:12.264Z (2 months ago)
- Topics: json, npm, package
- Language: Rust
- Homepage: https://crates.io/crates/package_json_schema
- Size: 132 KB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license
Awesome Lists containing this project
README
# 📦️ package_json_schema
> Load a `package.json` file as a PackageJson `struct`.
## Why?
You want to load a `package.json` file and interact with it as a struct.
## Installation
Add this line to the `[dependencies]` section of your `Cargo.toml`:
```toml
package_json_schema = "0.2"
```
If you would like to include validation then add the `validate` feature.
```toml
package_json_schema = { version = "0.2", features = ["validate"] }
```
This adds the `validator` crate as a dependency and adds the `.validate()` method to the `PackageJson` struct. The fields are validated according to the [JSON schema specification](https://json.schemastore.org/package.json).
## Usage
The following example shows how to load a `package.json` file and use it as a struct.
```rust
use package_json_schema::PackageJson;
let contents = r###"
{
"name": "my-package",
"version": "0.0.1",
"dependencies": {
"@sveltejs/kit": "1.0.0-next.396"
},
"peerDependencies": {
"aws-sdk": "2.1185.0"
}
}
"###;
let package_json = PackageJson::try_from(contents).unwrap();
assert_eq!(package_json.name.unwrap(), "my-package");
assert_eq!(package_json.version.unwrap(), "0.0.1");
```
This crate leaves it to the user to load the `package.json` content from the filesystem. Here is an example of loading the file contents and parsing the contents into a struct.
```rust
use std::fs::read_to_string;
use package_json_schema::PackageJson;
let contents = read_to_string("./tests/fixtures/1/package.json").unwrap();
let package_json = PackageJson::try_from(contents).unwrap();
assert_eq!(package_json.name.unwrap(), "test");
```
A `package.json` file can also be created from a builder.
```rust
use package_json_schema::PackageJson;
use package_json_schema::AdditionalFields;
use package_json_schema::Person;
use indexmap::IndexMap;
let mut additional_fields: AdditionalFields = IndexMap::new();
additional_fields.insert("custom".into(), "value".into());
let package_json = PackageJson::builder()
.name("awesome")
.author(Person::String("Tester".into()))
.other(additional_fields)
.build();
let string_value = package_json.try_to_string().unwrap();
assert_eq!(
string_value,
r#"{"name":"awesome","author":"Tester","custom":"value"}"#
);
```
To validate the `package.json` fields, enable the `validate` feature.
```toml
package_json_schema = { version = "0.2.1", features = ["validate"] }
```
And then use the `validate` method.
```rust
use std::fs::read_to_string;
use package_json_schema::PackageJson;
#[cfg(feature = "validate")]
use validator::Validate;
let contents = read_to_string("./tests/fixtures/1/package.json").unwrap();
let package_json = PackageJson::try_from(contents).unwrap();
#[cfg(feature = "validate")]
package_json.validate().unwrap();
```
## Contributing
[`devenv`](https://devenv.sh/) is used to provide a reproducible development environment for this project. Follow the [getting started instructions](https://devenv.sh/getting-started/).
To automatically load the environment you should [install direnv](https://devenv.sh/automatic-shell-activation/) and then load the `direnv`.
```bash
# The security mechanism didn't allow to load the `.envrc`.
# Since we trust it, let's allow it execution.
direnv allow .
```
At this point you should see the `nix` commands available in your terminal.
Run the following commands to install all the required dependencies.
```bash
install:all
```
This installs all cargo binaries locally so you don't need to worry about polluting your global namespace with required versions. The following scripts are added to your `PATH`.
### `scripts`
- build:all: Build all crates with all features activated.
- build:docs: Build documentation site.
- coverage:all: Generate a coverage report for the project
- fix:all: Fix all fixable issues
- fix:clippy: Fix all clippy issues
- fix:format: Format the files with dprint
- install:all: Install all packages.
- lint:all: Lint the whole codebase and fail if any issues found.
- lint:clippy: Check that lint rules are maintained for the entire project
- lint:format: Check that formatting is correct for the project.
- setup:ci: Setup the CI environment.
- snapshot:update: Update all snapshots when running the test suite.
- test:all: Run all tests for the project.
- update:deps: Update dependencies.
### Upgrading `devenv`
If you have an outdated version of `devenv` you can update it by running the following commands. If you have an easier way, please create a PR and I'll update these docs.
```bash
nix profile list # find the of the devenv package
nix profile upgrade
```
### Editor Setup
To setup recommended configuration for your favorite editor run the following commands.
```bash
setup:vscode # Setup vscode
```
## License
Unlicense, see the [LICENSE](./license) file.