Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

Commit 1ee5bec

Browse files
committed
refactor(apib): rename apib-parser
1 parent 8166782 commit 1ee5bec

File tree

11 files changed

+21
-17
lines changed

11 files changed

+21
-17
lines changed

.circleci/smoke.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ echo "Setting up Fury in $TMPDIR"
2323
create_package
2424
install api-elements
2525
install fury
26-
install fury-adapter-apib-parser
26+
install apib-parser
2727
install fury-adapter-swagger
2828
install fury-adapter-oas3-parser
2929
install fury-adapter-apiary-blueprint-parser

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ API Elements which can be used to validate API Description Documents.
88

99
API Elements adapters:
1010

11-
- [API Blueprint Parser](packages/fury-adapter-apib-parser)
11+
- [API Blueprint Parser](packages/apib-parser)
1212
- [API Blueprint Serializer](packages/fury-adapter-apib-serializer)
1313
- [OpenAPI 2 Parser](packages/fury-adapter-swagger)
1414
- [OpenAPI 3 Parser](packages/fury-adapter-oas3-parser)
@@ -21,7 +21,7 @@ const { Fury } = require('fury');
2121
const fury = new Fury();
2222

2323
// Load any parsers or serializer adapters you wish to use
24-
const apiBlueprintParser = require('fury-adapter-apib-parser');
24+
const apiBlueprintParser = require('@apielements/apib-parser');
2525
fury.use(apiBlueprintParser);
2626

2727
const openAPI2Parser = require('fury-adapter-swagger');

packages/fury-adapter-apib-parser/CHANGELOG.md renamed to packages/apib-parser/CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Fury API Blueprint Parser Changelog
1+
# API Elements: API Blueprint Parser Changelog
2+
3+
## Master
4+
5+
The package has been renamed to `@apielements/apib-parser`.
26

37
## 0.18.1 (2020-04-28)
48

packages/fury-adapter-apib-parser/README.md renamed to packages/apib-parser/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# Fury API Blueprint Parser
1+
# API Elements: API Blueprint Parser
22

3-
[![NPM version](https://img.shields.io/npm/v/fury-adapter-apib-parser.svg)](https://www.npmjs.org/package/fury-adapter-apib-parser)
4-
[![License](https://img.shields.io/npm/l/fury-adapter-apib-parser.svg)](https://www.npmjs.org/package/fury-adapter-apib-parser)
3+
[![NPM version](https://img.shields.io/npm/v/@apielements/apib-parser.svg)](https://www.npmjs.org/package/@apielements/apib-parser)
4+
[![License](https://img.shields.io/npm/l/@apielements/apib-parser.svg)](https://www.npmjs.org/package/@apielements/apib-parser)
55

66
This adapter provides support for parsing [API Blueprint](https://apiblueprint.org/) in [Fury.js](https://github.com/apiaryio/api-elements.js/tree/master/packages/fury) using the Node API Blueprint parser [Drafter NPM](https://github.com/apiaryio/drafter-npm).
77

88
## Install
99

1010
```sh
11-
npm install fury-adapter-apib-parser
11+
$ npm install @apielements/apib-parser
1212
```
1313

1414
## Usage
1515

1616
```js
1717
import fury from 'fury';
18-
import apibParser from 'fury-adapter-apib-parser';
18+
import apibParser from '@apielements/apib-parser';
1919

2020
fury.use(apibParser);
2121

packages/fury-adapter-apib-parser/package.json renamed to packages/apib-parser/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
{
2-
"name": "fury-adapter-apib-parser",
2+
"name": "@apielements/apib-parser",
33
"version": "0.18.1",
4-
"description": "API Blueprint parser for Fury.js",
4+
"description": "API Blueprint parser for API Elements",
55
"author": "Apiary.io <[email protected]>",
66
"license": "MIT",
77
"main": "./lib/adapter.js",
88
"files": [
99
"lib/adapter.js"
1010
],
11-
"homepage": "https://github.com/apiaryio/api-elements.js/tree/master/packages/fury-adapter-apib-parser",
11+
"homepage": "https://github.com/apiaryio/api-elements.js/tree/master/packages/apib-parser",
1212
"repository": {
1313
"type": "git",
1414
"url": "https://github.com/apiaryio/api-elements.js.git",
15-
"directory": "packages/fury-adapter-apib-parser"
15+
"directory": "packages/apib-parser"
1616
},
1717
"scripts": {
1818
"lint": "eslint .",

packages/fury-cli/lib/fury.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ const { highlight } = require('cardinal');
1111
const theme = require('cardinal/themes/tomorrow-night');
1212
const { JSON06Serialiser } = require('minim');
1313
const fury = require('fury');
14-
const apiBlueprintParser = require('fury-adapter-apib-parser');
14+
const apiBlueprintParser = require('@apielements/apib-parser');
1515
const apiBlueprintSerializer = require('fury-adapter-apib-serializer');
1616
const apiaryBlueprintParser = require('fury-adapter-apiary-blueprint-parser');
1717
const oas2Parser = require('fury-adapter-swagger');
1818
const oas3Parser = require('fury-adapter-oas3-parser');
1919
const pkg = require('../package.json');
2020

2121
const adapters = [
22-
'fury-adapter-apib-parser',
22+
'@apielements/apib-parser',
2323
'fury-adapter-apib-serializer',
2424
'fury-adapter-apiary-blueprint-parser',
2525
'fury-adapter-swagger',

packages/fury-cli/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"commander": "^5.1.0",
2727
"fury": "3.0.0-beta.14",
2828
"fury-adapter-apiary-blueprint-parser": "3.0.0-beta.11",
29-
"fury-adapter-apib-parser": "^0.18.1",
29+
"@apielements/apib-parser": "^0.18.1",
3030
"fury-adapter-apib-serializer": "^0.14.0",
3131
"fury-adapter-oas3-parser": "^0.11.1",
3232
"fury-adapter-swagger": "^0.29.0",

packages/fury/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Fury.js offers an interface based on the [Refract Project](https://github.com/re
2828

2929
```js
3030
import fury from 'fury';
31-
import apibParser from 'fury-adapter-apib-parser';
31+
import apibParser from '@apielements/apib-parser';
3232

3333
// The input as a string
3434
const source = 'FORMAT: 1A\n# My API\n...';

0 commit comments

Comments
 (0)