Skip to content

ncids-js 3.2.0

Install from the command line:
Learn more about npm packages
$ npm install @nciocpl/ncids-js@3.2.0
Install via package.json:
"@nciocpl/ncids-js": "3.2.0"

About this version

@nciocpl/ncids-js

JS library for the National Cancer Institute Design System

Installation

yarn

$ yarn add @nciocpl/ncids-js

npm

$ npm install @nciocpl/ncids-js

Usage

.ts

todo

.js

todo

Webpack

todo

etc

tood

Contributing

Guiding principles, style guides, and contributing instructions are found in the Github Wiki.

Also see The Way for more information.

Building

Compiles TypeScript into JavaScript.

$ npm run build

Under the hood:

  • Runs TypeScript compiler tsc -p tsconfig.json to output ES modules in ./lib/esm/
  • Runs tsc -p tsconfig-cjs.json to output CommonJS code ./lib/cjs/
  • Transpiles javascript for older browsers to ./dist/ with rollup --config via RollupJS and Babel

Testing

Tests are built with @testing-library/jest-dom.

$ npm run test

Tests should live in a __tests__ directory and expects a file name that matches **/?(*.)+(test).[jt]s?(x). I.e.:

  • ../__tests__/filename.test.ts

Tests expect consistent it usages within a describe scope.

describe('foo', () => {
  it('bar', () => {
    expect(screen.getbyRole('foobar'));
  });
});

Linting

ESlint rules should follow standards described in @nciocpl/eslint-config-vanilla-js

$ npm run lint

Details

Assets

  • ncids-js-3.2.0.tgz

Download activity

  • Total downloads 0
  • Last 30 days 0
  • Last week 0
  • Today 0

Recent versions

View all