rdf-ext - npm Package Compare versions

Comparing version 2.0.1 to 2.1.0

index.js

@@ -6,2 +6,3 @@ import Environment from '@rdfjs/environment/Environment.js'
 import PrefixMapFactory from '@rdfjs/prefix-map/Factory.js'
+import ScoreFactory from '@rdfjs/score/Factory.js'
 import TermMapFactory from '@rdfjs/term-map/Factory.js'
@@ -22,2 +23,3 @@ import TermSetFactory from '@rdfjs/term-set/Factory.js'
   PrefixMapFactory,
+  ScoreFactory,
   TermMapFactory,
@@ -38,2 +40,3 @@ TermSetFactory,
   PrefixMapFactory,
+  ScoreFactory,
   TermMapFactory,
@@ -40,0 +43,0 @@ TermSetFactory,

package.json

 {
   "name": "rdf-ext",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "RDF-Ext is a developer-friendly extension for RDF/JS",
@@ -8,3 +8,2 @@ "type": "module",
   "scripts": {
-    "coverage": "codecov",
     "test": "stricter-standard && c8 --reporter=lcov --reporter=text-summary mocha"
@@ -35,2 +34,3 @@ },
     "@rdfjs/prefix-map": "^0.1.0",
+    "@rdfjs/score": "^0.1.1",
     "@rdfjs/term-map": "^2.0.0",
@@ -45,3 +45,2 @@ "@rdfjs/term-set": "^2.0.0",
     "c8": "^7.7.3",
-    "codecov": "^3.8.2",
     "get-stream": "^6.0.1",
@@ -48,0 +47,0 @@ "mocha": "^9.0.2",

README.md

@@ -1,5 +0,3 @@
-# RDF-Ext
-
-[![Build Status](https://img.shields.io/github/workflow/status/rdf-ext/rdf-ext/CI)](https://github.com/rdf-ext/rdf-ext/actions/workflows/ci.yaml)
-
+# rdf-ext
+[![build status](https://img.shields.io/github/workflow/status/rdf-ext/rdf-ext/Test)](https://github.com/rdf-ext/rdf-ext/actions/workflows/test.yaml)
 [![npm version](https://img.shields.io/npm/v/rdf-ext.svg)](https://www.npmjs.com/package/rdf-ext)
@@ -9,2 +7,40 @@
 
+## Install
+
+```bash
+npm install --save rdf-ext
+```
+
+## Usage
+
+Just import the default export from the package:
+
+```javascript
+import rdf from 'rdf-ext'
+
+const term = rdf.namedNode('http://example.org/')
+```
+
+The exported object is an instance of [@rdfjs/environment](https://github.com/rdfjs-base/environment).
+The following factories are included in the environment:
+
+- [DataFactory](https://github.com/rdfjs-base/data-model)
+- [DatasetFactory](https://github.com/rdfjs-base/dataset)
+- [FetchFactory](https://github.com/rdfjs-base/fetch-lite)
+- [FormatsFactory](https://github.com/rdfjs-base/formats-common)
+- [NamespaceFactory](https://github.com/rdfjs-base/namespace)
+- [PrefixMapFactory](https://github.com/rdfjs-base/prefix-map)
+- [TermMapFactory](https://github.com/rdfjs-base/term-map/)
+- [TermSetFactory](https://github.com/rdfjs-base/term-set)
+- [TraverserFactory](https://github.com/rdfjs-base/traverser)
+
+### Experimental features
+
+The package contains experimental features which may break or be removed without being covered in the semantic versioning:
+
+- [ClownfaceFactory](https://github.com/rdf-ext/rdf-ext/blob/master/ClownfaceFactory.js)
+- [ScoreFactory](https://github.com/rdfjs-base/score/#factory)
+
+## Documentation & examples
+
 For more details, please check [rdf-ext.org](https://rdf-ext.org/)

test/test.js

@@ -42,2 +42,7 @@ import { doesNotThrow, strictEqual } from 'assert'
 
+  it('should implement the ScoreFactory interface', () => {
+    strictEqual(typeof rdf.score, 'object')
+    strictEqual(typeof rdf.score.sort, 'function')
+  })
+
   it('should implement the TermMapFactory interface', () => {
@@ -44,0 +49,0 @@ strictEqual(typeof rdf.termMap, 'function')

No alert changes

Improved metrics

Total package byte prevSize

38986

increased by3.95%

Dev dependency count

4

decreased by-20%

Lines of code

909

increased by0.78%

Number of lines in readme file

46

increased by360%

Worsened metrics

Dependency count

14

increased by7.69%

Dependency changes

• + Added@rdfjs/score@^0.1.1

• + Added@rdfjs/score@0.1.2(transitive)