Giter Club home page Giter Club logo

package-json-type's Introduction

package-json-type

npm

A TypeScript definition for package.json file

Usages

Install

npm install -S package-json-type
yarn add package-json-type

Import

import {
  IDependencyMap,
  IEngines,
  IPackageJson,
  SPDXLicenseIDApproved
} from 'package-json-type';

const dependency: IDependencyMap = {
  bar: '^1.0.0',
  baz: '^2.1.0',
  qux: 'file:../src/qux'
};

const engines: IEngines = {
  node: '>=6.0.1 <11.0.0',
  yarn: '^1.15.0',
  zlib: '^0.14.0'
};

const license: SPDXLicenseIDApproved = 'MIT';

const pkg: IPackageJson = {
  name: 'foo',
  version: '1.2.3',
  dependency,
  description: 'This is awesome foo',
  engines,
  license
};

Types

Documents

Issues

If you have any problems, please let us know on github issues.

Contributing

Contributions are always welcome :)

  1. If you'd like to contribute, please fork the repository
  2. run npm i or yarn inside the project
  3. run npm run dev to run in dev mode
  4. Make changes as you'd like
  5. To test run npm test or yarn test
  6. For clean code run npm run lint or yarn lint
  7. And send us your pull requests!

License

This project is licensed under MIT license.

package-json-type's People

Contributors

ajaxlab avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

package-json-type's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.