Comparing version 0.2.0 to 0.3.0
{ | ||
"name": "astrocite", | ||
"version": "0.2.0", | ||
"version": "0.3.0", | ||
"description": "Bibliography file format => AST => CSL JSON", | ||
@@ -10,10 +10,2 @@ "license": "MIT", | ||
"scripts": { | ||
"precommit": "lint-staged", | ||
"prepublish": "npm run build", | ||
"prepush": "npm test && npm run lint", | ||
"test": "jest src/**", | ||
"ci": "jest --coverage src/**", | ||
"postci": "npm run lint", | ||
"lint": "tslint -e \"**/*.js\" -p . -t codeFrame", | ||
"prebuild": "pegjs -o src/bibtex/grammar.js --cache src/bibtex/grammar.pegjs && pegjs -o src/ris/grammar.js --cache src/ris/grammar.pegjs", | ||
"build": "rm -rf lib/* && tsc -p ." | ||
@@ -39,11 +31,2 @@ }, | ||
"devDependencies": { | ||
"@types/jest": "^20.0.8", | ||
"@types/node": "^8.0.28", | ||
"husky": "^0.14.3", | ||
"jest": "^21.0.2", | ||
"lint-staged": "^4.1.3", | ||
"pegjs": "^0.10.0", | ||
"prettier": "^1.6.1", | ||
"ts-jest": "^21.0.0", | ||
"tslint": "^5.7.0", | ||
"typescript": "^2.5.2" | ||
@@ -50,0 +33,0 @@ }, |
@@ -7,2 +7,6 @@ [![Join the chat at https://gitter.im/astrocite/Lobby](https://badges.gitter.im/astrocite/Lobby.svg)](https://gitter.im/astrocite/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/dsifford/astrocite.svg?branch=master)](https://travis-ci.org/dsifford/astrocite) [![codecov](https://codecov.io/gh/dsifford/astrocite/branch/master/graph/badge.svg)](https://codecov.io/gh/dsifford/astrocite) | ||
**Mission:** The goal of this project is to create a single location where high-quality, safe, and efficient `X => CSL JSON` parsers can be found. | ||
**What this project solves:** Currently there exists a wide range of CSL JSON parsers for a variety of reference types. However, most of these parsers rely on unsafe or inefficent methods of parsing input files (generally using complex regular expressions with lookbehinds, or inefficiently looping over the same input text several times). This project abandons that strategy by first parsing input files into Abstract Syntax Trees and then parsing CSL JSON from the tree structure. The result of this is a safer, faster, and more predictable experience for developers. | ||
**NOTE:** This project is currently a work in progress. The API is subject to change drastically and without warning. Any use of this library is at your own risk until either this message disappears or version `^1.x.x` is released. | ||
@@ -30,5 +34,5 @@ | ||
// or | ||
var parse = require('astrocite/bibtex').parse; | ||
const parse = require('astrocite/bibtex').parse; | ||
const input = ` | ||
const cslJson = parse(` | ||
@article{my_article, | ||
@@ -38,5 +42,3 @@ title = {Hello world}, | ||
} | ||
`; | ||
const cslJson = parse(input); | ||
`); | ||
``` | ||
@@ -49,5 +51,5 @@ | ||
// or | ||
var astrocite = require('astrocite'); | ||
const astrocite = require('astrocite'); | ||
const input = ` | ||
const cslJson = astrocite.bibtex.parse(` | ||
@article{my_article, | ||
@@ -57,5 +59,3 @@ title = {Hello world}, | ||
} | ||
`; | ||
const cslJson = astrocite.bibtex.parse(input); | ||
`); | ||
``` | ||
@@ -68,4 +68,11 @@ | ||
// or | ||
import { AST } from 'astrocite/ris'; | ||
// import { AST } from 'astrocite/ris'; | ||
// ....etc | ||
const bibtexAST = AST.parse(` | ||
@article{my_article, | ||
title = {Hello world}, | ||
journal = "Some Journal" | ||
} | ||
`); | ||
``` | ||
@@ -77,3 +84,3 @@ | ||
PRs accepted. | ||
PRs accepted. Please see our [Roadmap](./.github/ROADMAP.md) and [Contributing Guidelines](./.github/CONTRIBUTING.md) for more details. | ||
@@ -80,0 +87,0 @@ ## License |
Empty package
Supply chain riskPackage does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
1
83
3729
2
0
2