Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 2.5 KB

README.md

File metadata and controls

73 lines (53 loc) · 2.5 KB
Raw

Deliquus

image

Deliquus aims to find missing test, story files and throw out an error. So you can use with husky and prevent developer from pushing the code before adding a test or story, or you know... anything.

Deliquus is a latin adjective meaning missing, wanting, lacking.

Usage

  • Install with yarn add --dev deliquus or npm install deliquus --save-dev
  • Create a valid cosmiconfig file (See: Cosmiconfig) that exports an object containing: 
    {
  sources: [{ pattern: 'GLOB_PATTERN', for: 'TARGET_NAME', name: 'SOURCE_NAME' }],
  targets: [{ pattern: 'GLOB_PATTERN', name: 'NAME' }],
}
    • Check deliquusrc.js file to see a working example.
    • You can set multiple sources with multiple targets.
    • You should reference target that you want to match the source with in for array in source object.
    • You can set multiple targets in for. For example you can check if stories and tests existing for components source without redefining the same directory.
  • Execute with yarn deliquus or npm run deliquus or bind to husky (recommended).

Development

  • Install dependencies

    $ yarn

  • Run in development mode

    $ yarn dev

  • Build

    $ yarn build

  • Run built package

    $ yarn start

LICENSE

MIT License

Copyright (c) 2021 ilyas akın

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.