@anolilab/resume-schema NPM

JSON Resume Schema

Standard, Specification, Schema

Getting started

npm install --save @anolilab/resume-schema

Usage

The main export of this package is an object that validates as a JSON schema. It should work with any compliant implementation.

Validation

To determine if an object is a valid JSON resume, you can do something like this:

import schema from "@anolilab/resume-schema/schema.json";
import Ajv from "ajv"; // validator. See https://ajv.js.org/
import addFormats from "ajv-formats";

const ajv = new Ajv({
    allowUnionTypes: true,
});

addFormats(ajv);

const validate = ajv.compile(schema);

validate({ basics: { name: "Thomas" } }); // true
validate({ invalidProperty: "foo bar" }); // false

People

Julian Shapiro for early prototype revisions

Contribute

We encourage anyone who’s interested in participating in evolving this standard to join the discussions here on GitHub. Also feel free to fork this project and submit new ideas to add to the JSON Resume Schema standard. To make sure all formatting is kept in check, install the EditorConfig plugin for your editor of choice.

Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Versioning

JSON Resume Schema adheres to Semantic Versioning 2.0.0. If there is a violation of this scheme, report it as a bug. Specifically, if a patch or minor version is released and breaks backward compatibility, that version should be immediately yanked and/or a new version should be immediately released that restores compatibility. Any change that breaks the public API will only be introduced at a major-version release. As a result of this policy, you can (and should) specify any dependency on JSON Resume Schema by using the Pessimistic Version Constraint with two digits of precision.