A utility belt that normalizes and wraps `Ramda` and `Lodash/FP`.
npm install omnibelt!Build Status 
A utility belt that normalizes and wraps Ramda and Lodash/FP. In addition, some other "adjunct" methods are included that solve common patterns. The order of precedence is: Does it exist in Ramda? Does it exist in Lodash/FP? Then it must be custom (in src/omnibelt). That means that you can deconstruct methods from any of those three from the omnibelt exported object.
``js`
const {
merge, converge, toString, // Ramda
isNull, throttle, camelCase, // Lodash
isPopulatedString, // Omnibelt
} = require('omnibelt');
... I've only grouped them for demonstration purposes, please don't do that in your code.
`bash`
yarn run test
Deconstruction
`js
const { isPopulatedString, toLower } = require('omnibelt');
const foo = 'foo';
if (!isPopulatedString(foo)) {
throw new Error('DANGER');
} else {
return toLower(foo);
}
`
Namespaced - Use O by convention
`js
const O = require('omnibelt');
const foo = 'foo';
if (!O.isPopulatedString(foo)) {
throw new Error('DANGER');
} else {
return O.toLower(foo);
}
`
- What is this method :: Type -> Type stuff? It's Hindley-Milner Notation.omnibelt
- Since most methods are straight from the source, refer to the Ramda and Lodash/FP on their respective sites.
- Docs and examples for the methods are collocated with the method's definition. When contributing a new function, please provide docs (and tests).
JSDoc definitions at the top of each of the omnibelt module functions should be kept up to date and are meant to describe the usage of each function in detail. From these doc comments, a documentation site is generated using the Docdash template.
You can open the docs locally by running the following npm script on a mac. In general (and for non-mac machines), you can simply opening docs/index.html in a browser.
`bash`
yarn run docs
You can also see documentation for the latest tag on the GitHub pages for this project.
https://losant.github.io/omnibelt/
#### Building
Docs should be generated when a new version is tagged and pushed. Ramda and Lodash docs are autogenerated as part of a pre build step and you shouldn't have to interface with manually updating which methods are being pulled in. Docs are committed to docs and are served as a GitHub page whenever master is updated.
`bash`
yarn run docs:build
git add -A
git commit -m "Regenerated docs"
`bashpackage.json
git co develop
git fetch
git pullUpdate
versionREADMEUpdate
changelog, naming the latest version`
yarn run docs:build
git add -A
git commit -m "version bump and doc regeneration"
git push
git checkout master
git merge develop
git release vX.X.X
Below should serve as an "upgrade guide" jumping off point as you are migrating projects to newer versions of this package. Ideally, interface changes will be called out specifically and one should not have to go sifting through git diffs to discern what changed.
-4.0.0
- moved from travis to github actions
- bumped ramda to
- bumped various dev dependencies
- drop support for node.js version 14 and 16.
-
- Added methods:
-
-
-
- Added methods:
- (Lodash)@rjhilgefort/export-dir
- removed .import { size } from 'omnibelt'
- updated index.js files to be destructured on import such as .3.1.0
-
- bumped .node-version to
- bumped ramda to (note in this version of ramda they release a function called isNotNil, omnibelt has a isNotNil function already so that ramda function is not included in this library)3.0.0
- bumped various dev dependencies
-
- bumped .node-version to
- drop support for node versions, 10, 12, 13, and 15
- bumped ramda version (note in this version of ramda they release a function called count, omnibelt has a count function already so that ramda function is not included in this library)1.5.0
- bumped @losant/eslint-config-losant to
- bumped expect to
- bumped fs-extra
- bumped husky
- bumped jest
- bumped jsdoc
- bumped lint-staged
- added taffdb as a dev dependency for building the documentation
-
- waits for all promises to complete and then throw the first error if foundmapParallelLimitP
- does not continue to run promises once a promise has erroredresolveProps
- waits for all promises to complete and then throws the first error if found2.0.2
-
- bumped .node-version to
- bumped lodash to
- bumped @losant/eslint-config-losant to
- bumped handlebars to
- bumped husky
- bumped jest
- bumped lint-staged
-
- Added
- bumped .node-version to
- bumped expect to
- bumped jest to
- bumped lint-staged to
-
- bumped to 0.27.1
- bumped to 4.17.20
- bumped to 2.0.0
- dropped support for Node.js 8 and 9
- various development dependencies updated
- added Node.js 13, 14, and 15 to travis
-
- bumped to 0.27.0
- bumped to 1.1.3
-
- bumped to 4.17.15
- bumped to 2.0.0
- various development dependencies updated
- stack trace improvement for
-
- Added methods:
-
-
- Updating linting, fix various spelling and linting errors
- bumped to 4.17.11
- Ramda upgraded from 0.25.0 to 0.26.1
- Removed internal implementation of thunkify, now comes from Ramda
- Removed , Ramda evolve now supports arrays with evolve
- bumped to 3.3.0
- Added methods:
-
-
-
- Removed methods:
-
- 0.26.0 Ramda now supports arrays1.2.0
-
- Repo renamed and open sourced!
-
- bumped to 4.17.10
- bumped to 1.0.0
- Added methods:
-
-
- Added methods:
-
- Method name change:
- -> timeoutP
-
- Ability to generate a static documentation site that's hosted on GitHub pages.
-
- Added methods:
-
-
- External changes:
- and the like, no longer assume that expect is available in your environment through jest. Instead, you must pass expect in as a dependency. See this issue for more info.1.3.2
- Internal changes:
- linter update to
- tests for
- tests for
-
- Added methods:
-
-
- Internal changes:
- Linter bumped and ran on project.
- Tests for .1.1.4
-
- ⬆️ Ramda upgrade to . Upgrade guide here.tap
- has been omitted from Ramda and implemented in this project to work around new version.toInteger
- Added methods:
- (Lodash)testHarness
- Remove methods:
- : Now is not exported as part of this library and is only used internallytest*
- Internal changes:
- methods have been moved to test/ and are only for internal use.testHarness
- has been updated with a new interface. testHarnessUnary is still around for backwards compatibility.testCases
- now exists to eliminate a common pattern when using testHarness.1.1.3
-
- All internal Losant utilities now only require the specific function(s) they need from /lodash.forEach
- The following methods are now pulled from Lodash instead of Ramda:
- : Note that forEachObjIndexed still comes from ramda (behaves as expected)indexBy
- Removed methods:
- from Ramda has been omitted in favor of keyBy
- from Lodash has been omitted because it conflicts poorly with nativedotPath
- Added methods:
-
-
-
-
-
- (Lodash)toNumber
- (Lodash)mapFilter
-
-
-
-
-
-
-
-
-
- Added methods:
-
-
- Added methods:
-
-
-
-
- All docs now collocated with implementations.
- Added methods:
-
-
-
-
- Removed methods:
-
- This is just (though flattenShallow is a bit more semantic).1.0.12
-
- back down to 0.24.1.1.0.11
-
- Moved git repo from Bitbucket to GitHub, update your remotes!
-
- Added methods:
-
-
-
-
-
- Moved methods:
- now comes from lodash/fp
- is now "custom" and accepts 3 arguments (still curried)debounce
- is now "custom" and accepts 3 arguments (still curried)1.0.10
-
- Node and Yarn version less restrictive, allows anything newer.
- Added methods:
-
-
- The following methods are now pulled from Lodash instead of Ramda:
-
-
-
-
-
-
- Added methods:
-
-
-
-
- now accepts an Error object and will rethrow when passed.1.0.7
-
- Converted to flat structure that exports all of the Lodash, Ramda, and custom methods that we're using.
- New documentation standard introduced, but not fully converted to.
- Dependency updates.
- Added methods:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Added methods:
-
-
-
-
-
-
-