atlassian-editorkit-lists-plugin

EditorKit Lists Plugin

Lists plugin for EditorKit

Usage

install dependencies:

npm install

install the editorkit type definitions

npm run typings

install typescript type definitions for the project

./node_modules/.bin/typings install

development mode

start development mode by running

npm run dev

this will watch for *.ts file changes on src and trigger compile, lint, test and trigger hot reload on the sandbox

manual process

compile your files

npm run compile

lint your typescript files

npm run lint

run your tests

npm test

run the sandbox

npm run sandbox - http://localhost:1988/

Adding new typescript types or updating custom types

Adding new types

When adding new library dependencies search for the type definition via

./node_modules/.bin/typings search foo

When definition is found install them and let it update your typings.json file example:

./node_modules/.bin/typings install dt~foo --global --save

Updating EditorKit types

Sometimes a new release of EditorKit may have new type definitions for its dependencies, you can update to it by, this will also update your typings.json definitions

npm run typings

Sometimes you need custom definitions for your project, you can do that by updating custom-types/main.d.ts followed by

./node_modules/.bin/typings install