# normalize-pkg > Normalize values in package.json using the map-schema library. Latest version **0.5.0** (published 2020-03-02) · MIT license · 0 weekly downloads ## Install ```sh npm install normalize-pkg pnpm add normalize-pkg yarn add normalize-pkg bun add normalize-pkg ``` Provides the command `normalize-pkg`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.5.0 | | Published | 2020-03-02 | | First published | 2014-03-25 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=10 | | Dependencies | 15 | | Unpacked size | 33.6 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 18 | | Author | Jon Schlinkert | | Maintainers | doowb, jonschlinkert | | Keywords | config, fix, json, normalize, package, package-json, pkg, properties, values | ## Links - npm: https://www.npmjs.com/package/normalize-pkg - Repository: https://github.com/jonschlinkert/normalize-pkg - Issues: https://github.com/jonschlinkert/normalize-pkg/issues - Funding: https://github.com/sponsors/jonschlinkert - npm.io page: https://npm.io/package/normalize-pkg ## Dependencies (15) - [semver](https://npm.io/package/semver.md) ^7.1.3 - [kind-of](https://npm.io/package/kind-of.md) ^6.0.3 - [matched](https://npm.io/package/matched.md) ^5.0.0 - [minimist](https://npm.io/package/minimist.md) ^1.2.0 - [arr-union](https://npm.io/package/arr-union.md) ^3.1.0 - [get-value](https://npm.io/package/get-value.md) ^3.0.1 - [map-schema](https://npm.io/package/map-schema.md) ^0.3.0 - [mixin-deep](https://npm.io/package/mixin-deep.md) ^2.0.1 - [omit-empty](https://npm.io/package/omit-empty.md) ^1.0.0 - [repo-utils](https://npm.io/package/repo-utils.md) ^0.4.1 - [write-json](https://npm.io/package/write-json.md) ^3.0.1 - [object.pick](https://npm.io/package/object.pick.md) ^1.3.0 - [export-files](https://npm.io/package/export-files.md) ^2.1.1 - [parse-git-config](https://npm.io/package/parse-git-config.md) ^3.0.0 - [stringify-author](https://npm.io/package/stringify-author.md) ^0.1.3 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 0.5.0 (latest) — 2020-03-02 - 0.4.1 — 2017-03-16 - 0.4.0 — 2017-01-30 - 0.3.20 — 2016-10-29 - 0.3.19 — 2016-10-25 - 0.3.18 — 2016-10-13 - 0.3.17 — 2016-10-13 - 0.3.16 — 2016-07-07 - 0.3.15 — 2016-07-07 - 0.3.14 — 2016-06-30 - 0.3.13 — 2016-06-13 - 0.3.12 — 2016-05-03 - 0.3.11 — 2016-04-27 - 0.3.10 — 2016-04-25 - 0.3.9 — 2016-04-14 - … 31 more at https://npm.io/package/normalize-pkg/versions ## README # normalize-pkg [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W8YFZ425KND68) [![NPM version](https://img.shields.io/npm/v/normalize-pkg.svg?style=flat)](https://www.npmjs.com/package/normalize-pkg) [![NPM monthly downloads](https://img.shields.io/npm/dm/normalize-pkg.svg?style=flat)](https://npmjs.org/package/normalize-pkg) [![NPM total downloads](https://img.shields.io/npm/dt/normalize-pkg.svg?style=flat)](https://npmjs.org/package/normalize-pkg) [![Build Status](https://travis-ci.org/jonschlinkert/normalize-pkg.svg?branch=master)](https://travis-ci.org/jonschlinkert/normalize-pkg) > Normalize values in package.json using the map-schema library. Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. ## Table of Contents
Details - [Install](#install) - [Install](#install-1) - [Usage](#usage) - [Features](#features) - [Schema](#schema) - [Defaults](#defaults) - [API](#api) - [Options](#options) * [options.knownOnly](#optionsknownonly) * [options.pick](#optionspick) * [options.omit](#optionsomit) * [options.fields](#optionsfields) * [options.extend](#optionsextend) - [About](#about)
## Install Install with [npm](https://www.npmjs.com/) (requires [Node.js](https://nodejs.org/en/) >= 0.10.0): ```sh $ npm install --save normalize-pkg ``` ## Install Install with [bower](https://bower.io/) ```sh $ bower install normalize-pkg --save ``` ## Usage ```js var config = require('./')(); var pkg = config.normalize(require('./package')); ``` ## Features Normalizes most package.json fields, and: * converts `repository` objects to a string * stringifies `author` object * stringifies each "person" object in `maintainers`, `contributors` and `collaborators` * converts `licenses` arrays and objects to a `license` string * removes files that don't exist from `bin`, `main` and the `files` array * adds `cli.js` to `bin` if it exists * creates `keywords` array from `name` if not defined See the [schema](lib/schema.js), [normalizers](lib/normalizers), and [unit tests](test) for more examples. ## Schema Values are normalized using a [schema](lib/schema.js) that is passed to [map-schema](https://github.com/jonschlinkert/map-schema). * only properties that have a corresponding field on the schema will be normalized. * any properties that do not have a corresponding field are returned unmodified. See the [.field docs](#field) to learn how to add or overwrite a field on the schema. ## Defaults A `default` value may optionally be defined when a `.field` is registered. When `.normalize` is run and a property that is required or recommended by npm is missing, `normalize-pkg` attempts to create the field if valid data can be found in the repository. built-in fields have a default value: * `version`: `'0.1.0'` * `license`: `'MIT'` * `engines`: `{node: '>= 0.10.0'}` For example: * `name`: the [project-name](https://github.com/jonschlinkert/project-name) library is used to fill in the name * `bin`: if empty, populated with `cli.js` or `bin` if either exists on the file system **Example** The following: ```js var config = require('./')(); // no package.json is passed, just an empty object var pkg = config.normalize({}); console.log(pkg); ``` **Results** Since an empty object was passed, `normalize-pkg` was smart enough to fill in missing fields looking for info in the project. In this case, specifically from parsing `.git` config and using any defaults defined on the schema. ```js { name: 'normalize-pkg', version: '0.1.0', homepage: 'https://github.com/jonschlinkert/normalize-pkg', repository: 'jonschlinkert/normalize-pkg', license: 'MIT', files: [ 'index.js' ], main: 'index.js', engines: { node: '>= 0.10.0' } } ``` ## API **Params** * `options` **{Object}** **Example** ```js const config = new NormalizePkg(); const pkg = config.normalize({ author: { name: 'Jon Schlinkert', url: 'https://github.com/jonschlinkert' } }); console.log(pkg); //=> {author: 'Jon Schlinkert (https://github.com/jonschlinkert)'} ``` * `normalize` **{Function}**: function to be called on the value when the `.normalize` method is called * `default` **{any}**: default value to be used when the package.json property is undefined. * `required` **{Boolean}**: define `true` if the property is required **Params** * `name` **{String}**: Field name (required) * `type` **{String|Array}**: One or more native javascript types allowed for the property value (required) * `options` **{Object}** * `returns` **{Object}**: Returns the instance **Example** ```js const config = new NormalizePkg(); config.field('foo', 'string', { default: 'bar' }); const pkg = config.normalize({}); console.log(pkg); //=> {foo: 'bar'} ``` **Params** * `pkg` **{Object}**: The `package.json` object to normalize * `options` **{Object}** * `returns` **{Object}**: Returns a normalized package.json object. **Example** ```js const config = new NormalizePkg(); const pkg = config.normalize(require('./package.json')); ``` ## Options ### options.knownOnly **Type**: `boolean` **Default**: `undefined` Omit properties from package.json that do not have a field registered on the schema. ```js var Config = require('normalize-pkg'); var config = new Config({knownOnly: true}); var pkg = config.normalize({name: 'my-project', foo: 'bar'}); console.log(pkg); //=> {name: 'my-project'} ``` ### options.pick **Type**: `array` **Default**: `undefined` Filter the resulting object to contain only the specified keys. ### options.omit **Type**: `array` **Default**: `undefined` Remove the specified keys from the resulting object. ### options.fields Pass a `fields` object on the options to customize any fields on the schema (also see [options.extend](#options-extend)): ```js var pkg = config.normalize(require('./package'), { extend: true, fields: { name: { normalize: function() { return 'bar' } } } }); console.log(pkg.name); //=> 'bar' ``` ### options.extend **Type**: `boolean` **Default**: `undefined` Used with [options.field](#options-field), pass `true` if you want to extend a field that is already defined on the schema. ```js var pkg = config.normalize(require('./package'), { extend: true, fields: { name: { normalize: function() { return 'bar' } } } }); console.log(pkg.name); //=> 'bar' ``` ## About
Contributing Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: ```sh $ npm install && npm test ```
Building docs _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ To generate the readme, run the following command: ```sh $ npm install -g verbose/verb#dev verb-generate-readme && verb ```
### Related projects You might also be interested in these projects: [update](https://www.npmjs.com/package/update): Be scalable! Update is a new, open source developer framework and CLI for automating updates… [more](https://github.com/update/update) | [homepage](https://github.com/update/update "Be scalable! Update is a new, open source developer framework and CLI for automating updates of any kind in code projects.") ### Contributors | **Commits** | **Contributor** | | --- | --- | | 154 | [jonschlinkert](https://github.com/jonschlinkert) | | 16 | [doowb](https://github.com/doowb) | | 2 | [pdehaan](https://github.com/pdehaan) | ### Author **Jon Schlinkert** * [GitHub Profile](https://github.com/jonschlinkert) * [Twitter Profile](https://twitter.com/jonschlinkert) * [LinkedIn Profile](https://linkedin.com/in/jonschlinkert) ### License Copyright © 2020, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT License](LICENSE). *** _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on March 01, 2020._ --- _Source: https://npm.io/package/normalize-pkg · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._