mod default;
mod ignore;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
/// A `package.json` is a JSON file that exists in the root of a JavaScript/Node.js project. It holds metadata relevant to the project and it's used for managing the project's dependencies, scripts, version and a whole lot more.
///
/// `package.json` schema from [official npm documentation](https://docs.npmjs.com/cli/v8/configuring-npm/package-json), see also [json-schemas repo](https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/package.json) and [json-schemas online](https://json.schemastore.org/package)
#[derive(Serialize, Deserialize, Debug, Default)]
#[serde(rename_all = "camelCase")]
pub struct PackageJson {
/// The [name](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#name) for the npm package
pub name: String,
/// The [version](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#version) for the npm package
pub version: String,
/// The [description](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#description-1) helps people discover your package, as it's listed in `npm search`.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// The [keywords](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#keywords) helps people discover your package as it's listed in `npm search`.
#[serde(skip_serializing_if = "Option::is_none")]
pub keywords: Option<Vec<String>>,
/// The url to the project [homepage](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#homepage).
#[serde(skip_serializing_if = "Option::is_none")]
pub homepage: Option<String>,
/// The url to your project's issue tracker and / or the email address to which issues should be reported.
/// These are helpful for people who encounter issues with your package.
#[serde(skip_serializing_if = "Option::is_none")]
pub bugs: Option<PackageBugs>,
/// The [license](https://spdx.org/licenses/) of the package.
#[serde(skip_serializing_if = "Option::is_none")]
pub license: Option<String>,
/// The [author](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#people-fields-author-contributors) of the package.
#[serde(skip_serializing_if = "Option::is_none")]
pub author: Option<PackagePeople>,
/// A list of [people](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#people-fields-author-contributors) who contributed to this package.
#[serde(skip_serializing_if = "Option::is_none")]
pub contributors: Option<Vec<PackagePeople>>,
/// A list of [people](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#people-fields-author-contributors) who maintains this package.
#[serde(skip_serializing_if = "Option::is_none")]
pub maintainers: Option<Vec<PackagePeople>>,
/// Used to inform about ways to help [fund](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#funding) development of the package.
#[serde(skip_serializing_if = "Option::is_none")]
pub funding: Option<Vec<PackageFunding>>,
/// The [files](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#files) field is an array of files to include in your project. If you name a folder in the array, then it will also include the files inside that folder.
#[serde(skip_serializing_if = "Option::is_none")]
pub files: Option<Vec<String>>,
/// The [main](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#main) field is a module ID that is the primary entry point to your program. That is, if your package is named `foo`, and a user installs it, and then does `require("foo")`, then your main module's exports object will be returned.
///
/// This should be a module relative to the root of your package folder.
///
/// For most modules, it makes the most sense to have a main script and often not much else.
///
/// If main is not set it defaults to `index.js` in the package's root folder.
#[serde(default = "default::main")]
pub main: String,
/// If your module is meant to be used client-side the [browser](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#browser) field should be used instead of the [main][PackageJson::main] field. This is helpful to hint users that it might rely on primitives that aren't available in Node.js modules. (e.g. window)
#[serde(skip_serializing_if = "Option::is_none")]
pub browser: Option<String>,
/// A lot of packages have one or more executable files that they'd like to install into the PATH. npm makes this pretty easy (in fact, it uses this feature to install the "npm" executable.)
///
/// To use this, supply a [bin](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#bin) field in your package.json which is a map of command name to local file name. When this package is installed globally, that file will be linked where global bins go so it is available to run by name. When this package is installed as a dependency in another package, the file will be linked where it will be available to that package either directly by npm exec or by name in other scripts when invoking them via npm run-script.
#[serde(skip_serializing_if = "Option::is_none")]
pub bin: Option<PackageBin>,
/// Specify either a single file or an array of filenames to put in place for the man program to find.
///
/// If only a single file is provided, then it's installed such that it is the result from `man <pkgname>`, regardless of its actual filename.
#[serde(skip_serializing_if = "Option::is_none")]
pub man: Option<PackageMan>,
/// [The CommonJS Packages spec](http://wiki.commonjs.org/wiki/Packages/1.0) details a few ways that you can indicate the structure of your package using a directories object. If you look at npm's package.json, you'll see that it has directories for doc, lib, and man.
#[serde(skip_serializing_if = "Option::is_none")]
pub directories: Option<PackageDirectories>,
/// Specify the place where your code lives. This is helpful for people who want to contribute. If the git repo is on GitHub, then the npm docs command will be able to find you.
#[serde(skip_serializing_if = "Option::is_none")]
pub repository: Option<PackageRepository>,
/// A dictionary containing script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point.
#[serde(default = "default::scripts")]
#[serde(skip_serializing_if = "ignore::ignore_scripts")]
pub scripts: HashMap<String, String>,
/// A [config](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#config) object can be used to set configuration parameters used in package scripts that persist across upgrades.
#[serde(skip_serializing_if = "Option::is_none")]
pub config: Option<HashMap<String, serde_json::Value>>,
/// [Dependencies](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#dependencies) are specified in a simple object that maps a package name to a version range. The version range is a string which has one or more space-separated descriptors. Dependencies can also be identified with a tarball or git URL.
///
/// Please do not put test harnesses or transpilers or other "development" time tools in your dependencies object. See [devDependencies](PackageJson::dev_dependencies).
#[serde(skip_serializing_if = "Option::is_none")]
pub dependencies: Option<PackageDependencies>,
/// If someone is planning on downloading and using your module in their program, then they probably don't want or need to download and build the external test or documentation framework that you use.
///
/// In this case, it's best to map these additional items in a [devDependencies](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#devdependencies) object.
#[serde(skip_serializing_if = "Option::is_none")]
pub dev_dependencies: Option<PackageDependencies>,
/// In some cases, you want to express the compatibility of your package with a host tool or library, while not necessarily doing a require of this host. This is usually referred to as a plugin. Notably, your module may be exposing a specific interface, expected and specified by the host documentation.
#[serde(skip_serializing_if = "Option::is_none")]
pub peer_dependencies: Option<PackageDependencies>,
/// When a user installs your package, npm will emit warnings if packages specified in peerDependencies are not already installed. The [peerDependenciesMeta](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#peerdependenciesmeta) field serves to provide npm more information on how your [peer dependencies][PackageJson::peer_dependencies] are to be used. Specifically, it allows peer dependencies to be marked as optional.
#[serde(skip_serializing_if = "Option::is_none")]
pub peer_dependencies_meta: Option<HashMap<String, HashMap<String, bool>>>,
/// An array of package names that will be bundled when publishing the package.
#[serde(skip_serializing_if = "Option::is_none")]
pub bundled_dependencies: Option<Vec<String>>,
/// If a dependency can be used, but you would like npm to proceed if it cannot be found or fails to install, then you may put it in the [optionalDependencies](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#optionaldependencies) object.
#[serde(skip_serializing_if = "Option::is_none")]
pub optional_dependencies: Option<PackageDependencies>,
/// If you need to make specific changes to dependencies of your dependencies, for example replacing the version of a dependency with a known security issue, replacing an existing dependency with a fork, or making sure that the same version of a package is used everywhere, then you may add an override.
///
/// [Overrides](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#overrides) provide a way to replace a package in your dependency tree with another version, or another package entirely. These changes can be scoped as specific or as vague as desired.
#[serde(skip_serializing_if = "Option::is_none")]
pub overrides: Option<HashMap<String, String>>,
/// Specify which [engines](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#engines) your module will run on.
#[serde(skip_serializing_if = "Option::is_none")]
pub engines: Option<HashMap<String, String>>,
/// Specify which [operating systems](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#os) your module will run on.
#[serde(skip_serializing_if = "Option::is_none")]
pub os: Option<Vec<String>>,
/// Specify which [cpu](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#cpu) your module will run on.
#[serde(skip_serializing_if = "Option::is_none")]
pub cpu: Option<Vec<String>>,
/// If set to true, then npm will refuse to publish it.
#[serde(default)]
pub private: bool,
/// This is a set of [config](https://docs.npmjs.com/cli/v8/using-npm/config) values that will be used at publish-time. It's
/// especially handy if you want to set the tag, registry or access, so that
/// you can ensure that a given package is not tagged with "latest", published
/// to the global public registry or that a scoped module is private by default.
#[serde(skip_serializing_if = "Option::is_none")]
pub publish_config: Option<HashMap<String, String>>,
/// The optional [workspace](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#workspaces)s
/// field is an array of file patterns that describes locations within the local
/// file system that the install client should look up to find each workspace
/// that needs to be symlinked to the top level node_modules folder.
#[serde(skip_serializing_if = "Option::is_none")]
pub workspaces: Option<Vec<String>>,
/// When set to "module", the type field allows a package to specify all .js files within are ES modules. If the "type" field is omitted or set to "commonjs", all .js files are treated as CommonJS.
#[serde(default = "default::r#type")]
pub r#type: String,
/// Set the [types](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#including-declarations-in-your-npm-package) property to point to your bundled declaration file. This is useful for packages that have a large number of types, but only a few of which are used.
#[serde(skip_serializing_if = "Option::is_none")]
pub types: Option<String>,
/// Note that the [typings](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#including-declarations-in-your-npm-package) field is synonymous with "types", and could be used as well.
#[serde(skip_serializing_if = "Option::is_none")]
pub typings: Option<String>,
/// Any unknown fields should be placed in `unknown` field.
#[serde(flatten)]
pub unknowns: HashMap<String, serde_json::Value>,
}
/// see [PackageJson::bugs](PackageJson::bugs)
#[derive(Serialize, Deserialize, Debug)]
#[serde(untagged)]
pub enum PackageBugs {
Url(String),
Record(PackageBugsRecord),
}
/// see [PackageJson::bugs](PackageJson::bugs)
#[derive(Serialize, Deserialize, Debug, Default)]
pub struct PackageBugsRecord {
pub url: Option<String>,
pub email: Option<String>,
}
#[derive(Serialize, Deserialize, Debug)]
#[serde(untagged)]
pub enum PackagePeople {
Literal(String),
Record(PackagePeopleRecord),
}
#[derive(Serialize, Deserialize, Debug, Default)]
pub struct PackagePeopleRecord {
pub name: String,
pub email: Option<String>,
pub url: Option<String>,
}
/// see [PackageJson::funding](PackageJson::funding)
#[derive(Serialize, Deserialize, Debug)]
#[serde(untagged)]
pub enum PackageFunding {
Url(String),
Record(PackageFundingRecord),
Slice(Vec<PackageFundingRecord>),
}
/// see [PackageJson::funding](PackageJson::funding)
#[derive(Serialize, Deserialize, Debug, Default)]
pub struct PackageFundingRecord {
pub r#type: String,
pub url: String,
}
/// see [PackageJson::bin](PackageJson::bin)
#[derive(Serialize, Deserialize, Debug)]
#[serde(untagged)]
pub enum PackageBin {
Literal(String),
Record(HashMap<String, String>),
}
/// see [PackageJson::man](PackageJson::man)
#[derive(Serialize, Deserialize, Debug)]
#[serde(untagged)]
pub enum PackageMan {
Literal(String),
Slice(Vec<String>),
}
/// see [PackageJson::directories](PackageJson::directories)
#[derive(Serialize, Deserialize, Debug, Default)]
pub struct PackageDirectories {
pub bin: Option<String>,
pub man: Option<String>,
}
/// see [PackageJson::repository](PackageJson::repository)
#[derive(Serialize, Deserialize, Debug)]
#[serde(untagged)]
pub enum PackageRepository {
Url(String),
Record(PackageRepositoryRecord),
}
#[derive(Serialize, Deserialize, Debug, Default)]
pub struct PackageRepositoryRecord {
pub r#type: String,
pub url: String,
pub directory: Option<String>,
}
pub type PackageDependencies = HashMap<String, String>;
#[test]
fn test_spec_fields() {
use self::default;
let package_json_raw = r#"
{
"name": "test",
"version": "1.0.0",
"description": "test",
"devDependencies": {
"typescript": "*"
}
}
"#;
let json = serde_json::from_str::<PackageJson>(package_json_raw).unwrap();
// test actual values
assert_eq!(json.name, "test");
assert_eq!(json.version, "1.0.0");
assert_eq!(json.description, Some("test".to_owned()));
assert_eq!(json.license, None);
assert_eq!(json.dependencies, None);
assert_eq!(
json.dev_dependencies,
Some(HashMap::from([("typescript".to_owned(), "*".to_owned())]))
);
assert_eq!(json.bundled_dependencies, None);
// test default values
assert!(!json.private, "json.private should be false");
assert_eq!(json.scripts, default::scripts());
assert_eq!(json.main, default::main());
assert_eq!(json.r#type, default::r#type());
}
#[test]
fn test_unknown_fields() {
let json = r#"
{
"name": "test",
"version": "1.0.0",
"description": "test",
"foo": "bar",
"baz": "qux"
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
assert_eq!(package_json.unknowns.len(), 2);
assert!(package_json.unknowns.contains_key("baz"));
assert!(package_json.unknowns.contains_key("baz"));
assert_eq!(package_json.unknowns.get("foo").unwrap(), &"bar".to_owned());
assert_eq!(package_json.unknowns.get("baz").unwrap(), &"qux".to_owned());
}
#[test]
fn test_repository_string() {
let json = r#"
{
"name": "test",
"version": "1.0.0",
"description": "test",
"repository": "gitlab:user/repo"
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
let expected = String::from("gitlab:user/repo");
match package_json.repository.unwrap() {
PackageRepository::Url(url) => {
assert_eq!(url, expected, "expected {} got {}", expected, url);
}
PackageRepository::Record(_) => {
panic!("expected a repository url, got a struct")
}
}
}
#[test]
fn test_repository_record() {
let json = r#"
{
"name": "test",
"version": "1.0.0",
"description": "test",
"repository": {
"type": "git",
"url": "git+https://github.com/npm/cli.git"
}
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
let expected = String::from("git+https://github.com/npm/cli.git");
match package_json.repository.unwrap() {
PackageRepository::Record(record) => {
assert_eq!(
record.url, expected,
"expected repository url {} got {}",
expected, record.url
);
}
PackageRepository::Url(_) => {
panic!("expected a repository structl, got a url")
}
}
}
#[test]
fn test_repository_record_with_directory() {
let json = r#"
{
"name": "test",
"version": "1.0.0",
"description": "test",
"repository": {
"type": "git",
"url": "git+https://github.com/npm/cli.git",
"directory": "workspaces/libnpmpublish"
}
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
let expected = String::from("workspaces/libnpmpublish");
match package_json.repository.unwrap() {
PackageRepository::Record(record) => {
let dir = record.directory.unwrap();
assert_eq!(
dir, expected,
"expected repository directory {} got {}",
expected, dir
);
}
PackageRepository::Url(_) => {
panic!("expected a repository struct, got a url")
}
}
}
#[test]
fn test_author_string_serialization() {
let json = r#"
{
"name": "package-name",
"private": true,
"version": "1.0.0",
"description": "Something for everyone",
"author": "A string value",
"license": "Apache-2.0",
"workspaces": [
"packages/*"
]
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
let expected = String::from("A string value");
match package_json.author.unwrap() {
PackagePeople::Record(_) => {
panic!("expected a auhor string, got a struct");
}
PackagePeople::Literal(literal) => {
assert_eq!(literal, expected, "expected {} got {}", expected, literal);
}
}
}
#[test]
fn test_author_object_serialization() {
let json = r#"
{
"name": "package-name",
"private": true,
"version": "1.0.0",
"description": "Something for everyone",
"author": {
"name": "Barney Rubble",
"email": "b@rubble.com",
"url": "http://barnyrubble.tumblr.com/"
},
"license": "Apache-2.0",
"workspaces": [
"packages/*"
]
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
let expected = String::from("http://barnyrubble.tumblr.com/");
match package_json.author.unwrap() {
PackagePeople::Record(record) => {
let author_url = record.url.unwrap();
assert_eq!(
author_url, expected,
"expected author url: {} got: {}",
expected, author_url
);
}
PackagePeople::Literal(_) => {
panic!("expected a auhor struct, got a string")
}
}
}
#[test]
fn test_config_with_bool_serialization() {
let json = r#"
{
"name": "package-name",
"private": true,
"version": "1.0.0",
"description": "Something for everyone",
"author": {
"name": "Barney Rubble",
"email": "b@rubble.com",
"url": "http://barnyrubble.tumblr.com/"
},
"config": {
"foo": true
},
"license": "Apache-2.0",
"workspaces": [
"packages/*"
]
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
let expected: bool = true;
assert_eq!(package_json.config.unwrap().get("foo").unwrap(), &expected);
}
#[test]
fn test_config_with_nested_serialization() {
let json = r#"
{
"name": "package-name",
"private": true,
"version": "1.0.0",
"description": "Something for everyone",
"author": {
"name": "Barney Rubble",
"email": "b@rubble.com",
"url": "http://barnyrubble.tumblr.com/"
},
"config": {
"commitizen": {
"path": "cz-conventional-changelog"
}
},
"license": "Apache-2.0",
"workspaces": [
"packages/*"
]
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
let expected: String = String::from("cz-conventional-changelog");
assert_eq!(
package_json
.config
.unwrap()
.get("commitizen")
.unwrap()
.get("path")
.unwrap(),
&expected
);
}
#[test]
fn test_bugs_with_nested_serialization() {
let json = r#"
{
"name": "package-name",
"private": true,
"version": "1.0.0",
"description": "Something for everyone",
"author": {
"name": "Barney Rubble",
"email": "b@rubble.com",
"url": "http://barnyrubble.tumblr.com/"
},
"bugs": {
"url": "https://github.com/jquery/esprima/issues"
}
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
let expected: String = String::from("https://github.com/jquery/esprima/issues");
match package_json.bugs.unwrap() {
PackageBugs::Url(_url) => {
panic!("expected a repository url, got a struct")
}
PackageBugs::Record(record) => {
let url = record.url.unwrap();
assert_eq!(url, expected, "expected {} got {}", expected, url);
}
}
}
#[test]
fn test_scripts_serialization() {
let json = r#"
{
"name": "my-project",
"version": "1.0.0",
"scripts": {
"start": "node index.js",
"test": "jest",
"build": "webpack --mode production",
"lint": "eslint ."
}
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
assert_eq!(package_json.scripts.get("start").unwrap(), "node index.js");
assert_eq!(package_json.scripts.get("test").unwrap(), "jest");
assert_eq!(
package_json.scripts.get("build").unwrap(),
"webpack --mode production"
);
assert_eq!(package_json.scripts.get("lint").unwrap(), "eslint .");
}
#[test]
fn test_dependencies_and_dev_dependencies() {
let json = r#"
{
"name": "my-library",
"version": "2.1.0",
"dependencies": {
"lodash": "^4.17.21",
"axios": "^0.21.1"
},
"devDependencies": {
"jest": "^27.0.6",
"typescript": "^4.3.5"
}
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
assert_eq!(
package_json
.dependencies
.as_ref()
.unwrap()
.get("lodash")
.unwrap(),
"^4.17.21"
);
assert_eq!(
package_json
.dependencies
.as_ref()
.unwrap()
.get("axios")
.unwrap(),
"^0.21.1"
);
assert_eq!(
package_json
.dev_dependencies
.as_ref()
.unwrap()
.get("jest")
.unwrap(),
"^27.0.6"
);
assert_eq!(
package_json
.dev_dependencies
.as_ref()
.unwrap()
.get("typescript")
.unwrap(),
"^4.3.5"
);
}
#[test]
fn test_engines_and_os() {
let json = r#"
{
"name": "node-specific-package",
"version": "1.2.3",
"engines": {
"node": ">=14.0.0",
"npm": ">=6.0.0"
},
"os": ["darwin", "linux"]
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
assert_eq!(
package_json.engines.as_ref().unwrap().get("node").unwrap(),
">=14.0.0"
);
assert_eq!(
package_json.engines.as_ref().unwrap().get("npm").unwrap(),
">=6.0.0"
);
assert_eq!(
package_json.os.as_ref().unwrap(),
&vec!["darwin".to_string(), "linux".to_string()]
);
}
#[test]
fn test_bin_and_man() {
let json = r#"
{
"name": "cli-tool",
"version": "3.0.1",
"bin": {
"my-cli": "./bin/cli.js"
},
"man": [
"./man/doc.1",
"./man/doc.2"
]
}"#;
let package_json = serde_json::from_str::<PackageJson>(json).unwrap();
match &package_json.bin {
Some(PackageBin::Record(bin_map)) => {
assert_eq!(bin_map.get("my-cli").unwrap(), "./bin/cli.js");
}
_ => panic!("Expected bin to be a Record"),
}
match &package_json.man {
Some(PackageMan::Slice(man_vec)) => {
assert_eq!(
man_vec,
&vec!["./man/doc.1".to_string(), "./man/doc.2".to_string()]
);
}
_ => panic!("Expected man to be a Slice"),
}
}