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.

Sign up for GitHub

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

Jump to bottom

Rename #7

Merged
merged 2 commits into from
Dec 28, 2022
Merged

Rename #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e65cf3
Merge pull request #6 from ShadSterling/2.3.X
ShadSterling Dec 28, 2022
940f6c6
Change NPM publication name to publish unscoped
ShadSterling Dec 28, 2022
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
17 changes: 8 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
<a href="http://promises-aplus.github.io/promises-spec">
<img src="http://promises-aplus.github.io/promises-spec/assets/logo-small.png"
align="right" alt="Promises/A+ logo" />
</a>
<a href="https://promisesaplus.com/"><img src="https://promisesaplus.com/assets/logo-small.png" align="right" alt="Promises/A+ logo" /></a>

# Promises/A+ Compliance Test Suite

This suite tests compliance of a promise implementation with the [Promises/A+ specification][].
This suite tests compliance of a promise implementation with the [Promises/A+ specification](https://github.com/promises-aplus/promises-spec).

[Promises/A+ specification]: https://github.com/promises-aplus/promises-spec
Passing the tests in this repo means that you have a Promises/A+ compliant implementation of the `then()` method, and you can display the [Promises/A+ logo](https://promisesaplus.com/assets/logo-small.png) in your README.

Passing the tests in this repo means that you have a Promises/A+ compliant implementation of the `then()` method, and you can display the Promises/A+ logo in your README. You can also [send a pull request](https://github.com/promises-aplus/promises-spec) to have your implementation listed on the [implementations page](https://promisesaplus.com/implementations).
The [original suite](https://github.com/promises-aplus/promises-tests) seems to have been abandoned; this fork passes [`npm audit`](https://docs.npmjs.com/auditing-package-dependencies-for-security-vulnerabilities) and adds [TypeScript](https://typescriptlang.org/) types, without changing any of the tests.

Before it was abandoned, you could also [send a pull request](https://github.com/promises-aplus/promises-spec) to have your implementation listed on the [implementations page](https://promisesaplus.com/implementations).

## How To Run

Expand Down Expand Up @@ -44,13 +43,13 @@ your implementation in `try`/`catch` when writing the adapter.
### From the CLI

This package comes with a command-line interface that can be used either by installing it globally with
`npm install @refreshed/promises-aplus-tests -g` or by including it in your `package.json`'s `devDependencies` and using npm's
`npm install promises-aplus-tests-refreshed -g` or by including it in your `package.json`'s `devDependencies` and using npm's
`scripts` feature. In the latter case, your setup might look something like

```json
{
"devDependencies": {
"@refreshed/promises-aplus-tests": "*"
"promises-aplus-tests-refreshed": "*"
},
"scripts": {
"test": "run-my-own-tests && promises-aplus-tests test/my-adapter"
Expand Down
10 changes: 5 additions & 5 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
{
"name": "@refreshed/promises-aplus-tests",
"name": "promises-aplus-tests-refreshed",
"description": "Compliance test suite for Promises/A+",
"keywords": ["promises", "promises-aplus"],
"version": "2.3.1",
"version": "2.3.2",
"implements": ["Promises/A+ 1.1.0"],
"author": "Domenic Denicola <d@domenic.me> (https://domenic.me)",
"contributors": [
"Domenic Denicola <d@domenic.me> (https://domenic.me)",
"Shad Sterling <me@shadsterling.com>"
],
"license": "WTFPL",
"repository": "ShadSterling/promises-aplus-tests",
"repository": "ShadSterling/promises-aplus-tests-refreshed",
"main": "lib/programmaticRunner.js",
"bin": "lib/cli.js",
"files": [
Expand Down