Giter Club home page Giter Club logo

parse-packagejson-name's Introduction

parsePackageJsonName

A very simple package to parse an npm package name and return some mildly interesting details about the name. It gives you back the following properties:

  • scope: The scope of the package, e.g. @foo/blip.blop's scope is 'foo'
  • fullName: The full name of the package, minus the scope, e.g. @foo/blip.blop's fullName is 'blip.blop'
  • projectName: If there is a . character in the fullName, then this can denote the module is part of a larger project, for example lodash has modules like lodash.pluck. Given the @foo/blip.blop example, projectName would be 'blip'
  • moduleName: Just like above - for our example of @foo/blip.blop, moduleName would be 'blop'.

Example

var parsePackageJsonName = require('parsePackageJsonName');

parsePackageJsonName('@foo/blip.blop').should.deep.equal({
  scope: 'foo',
  fullName: 'blip.blop',
  projectName: 'blip',
  moduleName: 'blop',
});

parsePackageJsonName('blip.blop').should.deep.equal({
  scope: null,
  fullName: 'blip.blop',
  projectName: 'blip',
  moduleName: 'blop',
});

parsePackageJsonName('blop').should.deep.equal({
  scope: null,
  fullName: 'blop',
  projectName: null,
  moduleName: 'blop',
});

parsePackageJsonName(require('lodash.pluck/package.json')).should.deep.equal({
  scope: null,
  fullName: 'lodash.pluck',
  projectName: 'lodash',
  moduleName: 'pluck',
});

parse-packagejson-name's People

Contributors

greenkeeperio-bot avatar keithamus avatar

Watchers

 avatar  avatar

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.