@plandek-utils/safe-compact
v2.0.1
Published
Lodash compact without removing 0, without `lodash`
Downloads
6,330
Readme
@plandek-utils/safe-compact
TypeDoc generated docs in here
utils similar to compact
, to remove certain "falsy" values.
Installation
yarn add @plandek-utils/safe-compact
or npm install @plandek-utils/safe-compact
.
Usage
safeCompact
returns a list with the "safe truthy" elements of the given list
import { safeCompact } from "@plandek-utils/safe-compact";
safeCompact(null) // => []
safeCompact(undefined) // => []
safeCompact([1, 0, NaN, Infinity, 1, null, 2, [], "", undefined, -1])
// => [1, 0, Infinity, 1, 2, [], -1]
filterNones
returns a list with the null
and undefined
elements removed
import { filterNones } from "@plandek-utils/safe-compact";
filterNones(null) // => []
filterNones(undefined) // => []
filterNones([0, NaN, Infinity, 1, null, 2, [], "", false, undefined, -1])
// => [0, NaN, Infinity, 1, 2, [], "", false, -1]
isNotNone
returns true if the value is not null
nor undefined
import { isNotNone } from "@plandek-utils/safe-compact";
isNotNone(null) // => false
isNotNone(undefined) // => false
isNotNone([]) // => true
isNotNone(false) // => true
isNotNone(0) // => true
isNotNone("") // => true
isNotNone("aaa") // => true
safeIsTruthy
returns true if the value is truthy or if it is 0.
import { safeIsTruthy } from "@plandek-utils/safe-compact";
safeIsTruthy(1) // => true
safeIsTruthy(0) // => true
safeIsTruthy("") // => false
safeIsTruthy(null) // => false
safeIsTruthy(undefined) // => false
safeIsTruthy(NaN) // => false
Development, Commits, versioning and publishing
See The Typescript-Starter docs.
Commits and CHANGELOG
For commits, you should use commitizen
yarn global add commitizen
#commit your changes:
git cz
As typescript-starter docs state:
This project is tooled for conventional changelog to make managing releases easier. See the standard-version documentation for more information on the workflow, or CHANGELOG.md
for an example.
# bump package.json version, update CHANGELOG.md, git tag the release
yarn run version
You may find a tool like wip
helpful for managing work in progress before you're ready to create a meaningful commit.
Creating the first version
Once you are ready to create the first version, run the following (note that reset
is destructive and will remove all files not in the git repo from the directory).
# Reset the repo to the latest commit and build everything
yarn run reset && yarn run test && yarn run doc:html
# Then version it with standard-version options. e.g.:
# don't bump package.json version
yarn run version -- --first-release
# Other popular options include:
# PGP sign it:
# $ yarn run version -- --sign
# alpha release:
# $ yarn run version -- --prerelease alpha
And after that, remember to publish the docs.
And finally push the new tags to github and publish the package to npm.
# Push to git
git push --follow-tags origin master
# Publish to NPM (allowing public access, required if the package name is namespaced like `@somewhere/some-lib`)
yarn publish --access public
Publish the Docs
yarn run doc:html && yarn run doc:publish
This will generate the docs and publish them in github pages.
Generate a version
There is a single yarn command for preparing a new release. See One-step publish preparation script in TypeScript-Starter
# Prepare a standard release
yarn prepare-release
# Push to git
git push --follow-tags origin master
# Publish to NPM (allowing public access, required if the package name is namespaced like `@somewhere/some-lib`)
yarn publish --access public