Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] master from jsonresume:master #24

Open
wants to merge 21 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
995fef2
fix: add scheme to sample project URL
rbardini Oct 20, 2023
cd8ca01
fix: pin sample resume canonical URL version
rbardini Oct 21, 2023
77c3456
Update README.md
thomasdavis Jul 4, 2024
3f354a4
Update README.md
thomasdavis Jul 4, 2024
34fc6c2
feat: added a draft to support a job description schema
thomasdavis Jul 10, 2024
e504d4e
feat: added more support for job description schema
thomasdavis Jul 10, 2024
a8e02f6
Merge pull request #471 from rbardini/fix-sample-project-url
thomasdavis Jul 10, 2024
6547608
Merge pull request #472 from rbardini/fix-sample-canonical-version
thomasdavis Jul 10, 2024
0b438ea
feat: updated schema npm version. added new instructions
thomasdavis Jul 10, 2024
5593c70
feat: changed namespace of schema package to @jsonresume/schema
thomasdavis Jul 10, 2024
7a892ba
feat: changed schema validator library
thomasdavis Jul 10, 2024
3e7b454
fix: update deps
thomasdavis Jul 10, 2024
ec13c2e
fix: correctly use new validator in date specs
thomasdavis Jul 10, 2024
9b59f30
fix: bump supported node to 18,20
thomasdavis Jul 10, 2024
2893026
updating semantic release version
thomasdavis Jul 10, 2024
f5b33c8
fix: cleaned up editor configs. added job schema to package export
thomasdavis Jul 10, 2024
d0c3948
feat: bumping package manually
thomasdavis Jul 10, 2024
faeb0ac
fix: schema spacing
jrschumacher Jul 20, 2024
48869d8
Fix: Sample Resume does not conform to schema
DandyLyons Aug 3, 2024
de205e8
Merge pull request #488 from DandyLyons/master
thomasdavis Aug 3, 2024
50798e3
Merge pull request #484 from jrschumacher/patch-1
thomasdavis Aug 6, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions .editorconfig

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/latest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node: [10, 12]
node: [18, 20]
steps:
- name: Checkout
uses: actions/checkout@v1
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node: [10, 12, 14]
node: [18, 20]
name: Test on Node.js ${{ matrix.node }}
steps:
- name: Checkout
Expand Down Expand Up @@ -40,7 +40,7 @@ jobs:
run: npm ci

- name: Run semantic-release
uses: cycjimmy/semantic-release-action@v2
uses: cycjimmy/semantic-release-action@v4
with:
extra_plugins: |
conventional-changelog-conventionalcommits
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node: [10, 12]
node: [18, 20]
steps:
- name: Checkout
uses: actions/checkout@master
Expand Down
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"singleQuote": true
}

2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright © 2014 JSON Resume
Copyright © 2024 JSON Resume

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
41 changes: 34 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,37 @@
[![Latest Status](https://github.com/jsonresume/resume-schema/workflows/Latest/badge.svg)](https://github.com/vanillawc/wc-template/actions)
[![Release Status](https://github.com/jsonresume/resume-schema/workflows/Release/badge.svg)](https://github.com/vanillawc/wc-template/actions)

[![](https://dcbadge.limes.pink/api/server/GTZtn8pTXC)](https://discord.gg/GTZtn8pTXC)

Standard, Specification, Schema

## Important Note

The current working version of the schema is `v1.0.0` that is represented by the `master` branch and the files `schema.json` and `sample.resume.json`.

All PR's for the next version should be made against the `develop` branch.

This enforces that the schema package always has the official stable release of the schema.

### Homepage and Registry

If you are looking for the homepage, registry, tooling or themes, see the JSON Resume monorepo

[@jsonresume/jsonresume.org](https://github.com/jsonresume/jsonresume.org/)


### Getting started

```
npm install --save resume-schema
npm install --save @jsonresume/schema
```

To use

```js
const resumeSchema = require("resume-schema");
import resumeSchema from '@jsonresume/schema';
resumeSchema.validate(
{ name: "Thomas" },
{ basics: { name: "Thomas" } },
function (err, report) {
if (err) {
console.error("The resume was invalid:", err);
Expand All @@ -32,12 +49,12 @@ resumeSchema.validate(
);
```

More likely
Or against a full `resume.json`

```js
var fs = require("fs");
var resumeSchema = require("resume-schema");
var resumeObject = JSON.parse(fs.readFileSync("resume.json", "utf8"));
import fs = require('fs');
import schema from 'resume-schema';
const resumeObject = JSON.parse(fs.readFileSync('./resume.json', 'utf8'));
resumeSchema.validate(resumeObject);
```

Expand Down Expand Up @@ -73,6 +90,16 @@ Pull requests titles should be formatted as such

`major` version bumps will be few and far between for this schema.

### Job Description Schema

A draft schema for job descriptions is available in this project as well. It is not yet finalized, but we encourage you to check it out and provide feedback. See `job-schema.json` and `sample.job.json`.

The JSON Job schema is available from:

```js
require("resume-schema").jobSchema;
```

### Other resume standards

- [HR-XML](https://schemas.liquid-technologies.com/HR-XML/2007-04-15/)
Expand Down
141 changes: 141 additions & 0 deletions job-schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"iso8601": {
"type": "string",
"description": "Similar to the standard date type, but each section after the year is optional. e.g. 2014-06-29 or 2023-04",
"pattern": "^([1-2][0-9]{3}-[0-1][0-9]-[0-3][0-9]|[1-2][0-9]{3}-[0-1][0-9]|[1-2][0-9]{3})$"
}
},
"properties": {
"title": {
"type": "string",
"description": "e.g. Web Developer"
},
"company": {
"type": "string",
"description": "Microsoft"
},
"type": {
"type": "string",
"description": "Full-time, part-time, contract, etc."
},
"date": {
"$ref": "#/definitions/iso8601"
},
"description": {
"type": "string",
"description": "Write a short description about the job"
},
"location": {
"type": "object",
"additionalProperties": true,
"properties": {
"address": {
"type": "string",
"description": "To add multiple address lines, use \\n. For example, 1234 Glücklichkeit Straße\\nHinterhaus 5. Etage li."
},
"postalCode": {
"type": "string"
},
"city": {
"type": "string"
},
"countryCode": {
"type": "string",
"description": "code as per ISO-3166-1 ALPHA-2, e.g. US, AU, IN"
},
"region": {
"type": "string",
"description": "The general region where you live. Can be a US state, or a province, for instance."
}
}
},
"remote": {
"type": "string",
"description": "the level of remote work available",
"enum": [
"Full",
"Hybrid",
"None"
]
},
"salary": {
"type": "string",
"description": "100000"
},
"experience": {
"type": "string",
"description": "Senior or Junior or Mid-level"
},
"responsibilities": {
"type": "array",
"description": "what the job entails",
"additionalItems": false,
"items": {
"type": "string",
"description": "e.g. Build out a new API for our customer base."
}
},
"qualifications": {
"type": "array",
"description": "List out your qualifications",
"additionalItems": false,
"items": {
"type": "string",
"description": "undergraduate degree, etc. "
}
},
"skills": {
"type": "array",
"description": "List out your professional skill-set",
"additionalItems": false,
"items": {
"type": "object",
"additionalProperties": true,
"properties": {
"name": {
"type": "string",
"description": "e.g. Web Development"
},
"level": {
"type": "string",
"description": "e.g. Master"
},
"keywords": {
"type": "array",
"description": "List some keywords pertaining to this skill",
"additionalItems": false,
"items": {
"type": "string",
"description": "e.g. HTML"
}
}
}
}
},
"meta": {
"type": "object",
"description": "The schema version and any other tooling configuration lives here",
"additionalProperties": true,
"properties": {
"canonical": {
"type": "string",
"description": "URL (as per RFC 3986) to latest version of this document",
"format": "uri"
},
"version": {
"type": "string",
"description": "A version field which follows semver - e.g. v1.0.0"
},
"lastModified": {
"type": "string",
"description": "Using ISO 8601 with YYYY-MM-DDThh:mm:ss"
}
}
}
},
"title": "Job Description Schema",
"type": "object"
}
Loading