dictionaryofpatterns
THIS PROJECT IS STILL IN THE DESIGN PHASE
IDEAS & CONTRIBUTIONS ARE WELCOME
An Open Source Universe Project
Contents
Features β¨
- List of Patterns
Planned
- Definitions for Each Pattern
Planned
- Visuals for Each Pattern
Planned
- Searchable Grid of All Patterns Organized by Topic
Planned
- Code Components for Each Pattern
Planned
- Pattern Validation Code for Each Pattern
Planned
Install π
npm install dictionaryofpatterns
Usage π
Read more about the Design behind dictionaryofpatterns
here.
import { fullTestCoverage } from 'dictionaryofpatterns';
// Search the Dictionary of Patterns Public Grid to Understand the definition of fullTestCoverage
const { passing } = await fullTestCoverage({
src: 'path/to/app/source/code',
testCommand: 'npm run test',
coverageDir: 'path/to/coverage/reporter/output',
coverageReporter: 'lcov'
});
// passing = true, if your application has 100% test coverage.
Documentation π°
dictionaryofpatterns
is under active development, documentation will be added once an initial release is ready.
Contributing π
We would love for you to contribute your ideas, code, & fixes to dictionaryofpatterns
.
We encourage everyone to read our Design Document to learn more about the thought process behind dictionaryofpatterns.
Also check out the rewards offered for contributing to the Open Source Universe.
License βοΈ
MIT