npmpackage.info

Gathering detailed insights and metrics for aft-vitest-reporter

aft-vitest-reporter - 12.1.1 | npmpackage.info

aft-vitest-reporter

Automated Functional Testing (AFT) packages supporting nodejs based Functional Testing

12.1.1

MIT

TypeScript

120.36 kB

2.6

Installations

npm install aft-vitest-reporter

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

18.20.2

NPM Version

lerna/7.4.2/node@v18.20.2+x64 (linux)

Pull Requests

Open

5

Total

94

Closed

61

Merged

28

Issues

Open

0

Total

3

Closed

3

Releases

Unable to fetch releases

Languages

TypeScript

HTML

JavaScript

TypeScript (96.95%)

HTML (2.78%)

JavaScript (0.27%)

Developer

bicarbon8

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

52 Commits

1 Watchers

6 Branches

1 Contributors

Updated on May 24, 2024

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

12.1.1

Package Id

aft-vitest-reporter@12.1.1

Unpacked Size

120.36 kB

Size

30.18 kB

File Count

NPM Version

lerna/7.4.2/node@v18.20.2+x64 (linux)

Node Version

18.20.2

Published on

May 23, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

aft-core vitest

Dev Dependencies

@types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser @vitest/coverage-istanbul aft-reporting-filesystem aft-reporting-html eslint nyc rimraf rollup typescript

AFT-Vitest-Reporter

a Vitest Reporter integration for AFT providing support for AFT plugins, configuration and helpers

Installation

> npm i aft-vitest-reporter

Vitest Configuration

using this Reporter requires either calling the vitest command with the following argument --reporter=aft-vitest-reporter or from within a vitest.config.mjs file like the following:

1// vitest.config.mjs
2import { defineConfig, configDefaults } from 'vitest/config';
3
4export default defineConfig({
5  ...configDefaults,
6  test: {
7    reporters: ['default', './node_modules/aft-vitest-reporter/dist/src/aft-vitest-reporter.js'],
8    environment: 'node',
9  }
10});

AFT Helpers

this package comes with two helper classes that can be utilised from within your Vitest specs to make use of AFT features.

`AftVitestTest`

the AftVitestTest class extends from the AftTest class providing the ability to parse the Spec name for any referenced Test. each Test ID must be surrounded with square brackets [ABC123]. you can then either directly call the AftVitestTest.shouldRun() async function which will determine if your test should be run based on any AFT PolicyPlugin instances referenced in your aftconfig.json file or you can call aftVitestTest(this, testFunction) which will perform the AftVitestTest.shouldRun() call and mark the test as skipped if it should not be run. using the AftVitestTest class would look like the following:

!!WARNING!! using arrow functions in your Spec definition IS NOT SUPPORTED if using AftVitestTest because it removes the this scope

1describe('YourTestSuite', () => {
2    // use `aftVitestTest` to report results
3    it('can check if test [C1234] should be run', async function() {
4        await aftVitestTest(this, async (v: AftVitestTest) => {
5            // calls `v.test.skip()` if should not be run
6            await v.reporter.error('we should never get here if C1234 should not be run');
7            const result = await doStuff();
8            await t.verify(result, equaling('expected'));
9        }); // handles submitting the result to any AFT Reporter Plugins
10    });
11
12    // use `AftVitestReporter` to report results
13    it('can check if test [C2345] should be run', async function() {
14        const aft = new AftVitestTest(this);
15        const shouldRun = await aft.shouldRun();
16        if (shouldRun.result !== true) {
17            await aft.pending(shouldRun.message); // marks test as skipped
18        }
19        const result = await doStuff();
20        expect(result).to.equal('expected'); // AftVitestReporter handles submitting the result to any AFT Reporter Plugins
21    });
22});

which would output the following to your console and any AFT ReportingPlugin instances referenced in your aftconfig.json if the test ID should not be run:

117:52:45 - [YourTestSuite can check if test [C1234] should be run] - WARN - none of the supplied tests should be run: [C1234]
217:52:45 - [YourTestSuite can check if test [C1234] should be run] - WARN - test skipped

NOTES

the AftVitestTest constructors expects to be passed a valid scope containing reference to the currently executing Vitest.Test. typically this will be an object passed in to your test or it function within your Spec
this Vitest Reporter works in both parallel and sequential execution modes, but you MUST ALWAYS pass a context to your it or test function if you are using AftVitestTest class within your Spec
the aft-vitest-reporter Vitest Reporter can be used when testing with an environment of node or jsdom or any of the supported Vitest environment config values, but the AftVitestTest class and aftVitestTest function can only be used with your environment set to node via your vitest.config.mjs file

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 2

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-test-deploy-main.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/bicarbon8/automated-functional-testing/build-test-deploy-main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-test-deploy-main.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/bicarbon8/automated-functional-testing/build-test-deploy-main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-test-pull-requests.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/bicarbon8/automated-functional-testing/build-test-pull-requests.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-test-pull-requests.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/bicarbon8/automated-functional-testing/build-test-pull-requests.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pages-build-deployment.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/bicarbon8/automated-functional-testing/pages-build-deployment.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pages-build-deployment.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/bicarbon8/automated-functional-testing/pages-build-deployment.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pages-build-deployment.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/bicarbon8/automated-functional-testing/pages-build-deployment.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pages-build-deployment.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/bicarbon8/automated-functional-testing/pages-build-deployment.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pages-build-deployment.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/bicarbon8/automated-functional-testing/pages-build-deployment.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/run-test-examples.yml:7: update your workflow using https://app.stepsecurity.io/secureworkflow/bicarbon8/automated-functional-testing/run-test-examples.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/run-test-examples.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/bicarbon8/automated-functional-testing/run-test-examples.yml/main?enable=pin
Info: 0 out of 11 GitHub-owned GitHubAction dependencies pinned
Info: 4 out of 4 npmCommand dependencies pinned

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.6

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More