{"id":15684195,"url":"https://github.com/alan-agius4/speedy-build-tools","last_synced_at":"2025-05-07T08:31:23.776Z","repository":{"id":52546184,"uuid":"81549719","full_name":"alan-agius4/speedy-build-tools","owner":"alan-agius4","description":"Node CLI and API to build your application and library...","archived":false,"fork":false,"pushed_at":"2021-04-26T15:31:32.000Z","size":359,"stargazers_count":10,"open_issues_count":16,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-31T08:12:04.758Z","etag":null,"topics":["api","build","cli","html","lint","node","node-cli","sass","scripts","stylelint","tools"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alan-agius4.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-10T09:34:05.000Z","updated_at":"2022-02-06T15:28:28.000Z","dependencies_parsed_at":"2022-09-14T05:21:13.888Z","dependency_job_id":null,"html_url":"https://github.com/alan-agius4/speedy-build-tools","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alan-agius4%2Fspeedy-build-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alan-agius4%2Fspeedy-build-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alan-agius4%2Fspeedy-build-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alan-agius4%2Fspeedy-build-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alan-agius4","download_url":"https://codeload.github.com/alan-agius4/speedy-build-tools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252563011,"owners_count":21768384,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","build","cli","html","lint","node","node-cli","sass","scripts","stylelint","tools"],"created_at":"2024-10-03T17:12:47.190Z","updated_at":"2025-05-07T08:31:23.746Z","avatar_url":"https://github.com/alan-agius4.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @speedy/build-tools\n[![CircleCI](https://circleci.com/gh/alan-agius4/speedy-build-tools.svg?style=shield)](https://circleci.com/gh/alan-agius4/speedy-build-tools)\n[![npm version](https://img.shields.io/npm/v/@speedy/build-tools.svg)](https://www.npmjs.com/package/@speedy/build-tools)\n[![Dependency Status](https://img.shields.io/david/alan-agius4/speedy-build-tools.svg?style=flat-square)](https://david-dm.org/alan-agius4/speedy-build-tools)\n[![devDependency Status](https://img.shields.io/david/dev/alan-agius4/speedy-build-tools.svg?style=flat-square)](https://david-dm.org/alan-agius4/speedy-build-tools?type=dev)\n\nNode CLI/API for build tools and utilities such as linting (html, sass, ts), clean, compile, etc...\nin order to simplify building libraries and applications.\n\n**Currently under development.**\n\n## Getting Started\n\n### Installation\n\n```\nnpm install @speedy/build-tools --save-dev\n```\n\n## NPM Scripts\n\nInstead of depending on external task runners, `speedy-build-tools` can be configured to run from npm scripts in `package.json`.\n\n```json\n\"scripts\": {\n    \"lint-sass\": \"speedy-build-tools lint-sass\",\n    \"lint-ts\": \"speedy-build-tools lint-ts\"\n},\n````\n\nRun NPM script as following\n\n```\nnpm run lint-sass\n```\n\n## CLI\n\nCLI can also be used directly without being added to NPM scripts.\n\n```\nspeedy-build-tools clean --paths **/.tmp\n\n// or shorthand\nspeedy clean --paths **/.tmp\n```\n\n## Tasks\nAvailable tasks within `speedy-build-tools` which can be used via CLI.\n\n\n| Task               | Description                  |\n|--------------------|------------------------------|\n| `clean [paths...]` | Delete files and directories |\n| `copy`             | Copy files and directories   |\n| `lint-html`        | Lint Html files              |\n| `lint-sass`        | Lint Sass files              |\n| `lint-ts`          | Lint TypeScript files        |\n___\n\n### Clean\n\n```\nspeedy-build-tools clean --paths .tmp/**\nspeedy-build-tools clean .tmp/** .test/**\n```\n\n| Option          | Description                                   | Type  |\n|-----------------|-----------------------------------------------|-------|\n| `--paths`, `-p` | Paths to be deleted - Supports glob patterns  | Array |\n\n___\n\n### Copy\n\n```\nspeedy-build-tools copy --paths .tmp/** --dest www\n```\n\n| Option        | Description                                   | Type   |\n|---------------|-----------------------------------------------|--------|\n| `--paths, -p` | Paths to be copied - Supports glob patterns   | Array  |\n| `--dest, -d`  | Destination of the copied files               | string |\n\n___\n\n### Lint Html\n\n```\nspeedy-build-tools lint-html\n```\n\n| Option              | Description                                                           | Default Value           | Type    |\n|---------------------|-----------------------------------------------------------------------|-------------------------|---------|\n| `--config`, `-c`    | Lint rules file path                                                  | `.htmlhintrc`           | string  |\n| `--files`, `-f`     | Files to be linted - Supports glob patterns                           | `src/**/*.*(html\\|htm)` | Array   |\n| `--continueOnError` | Determines whether to exit with a non-zero status code on lint errors | `false`                 | boolean |\n\n#### Rules\nBy default, it will try to locate the `.htmlhintrc` file in the root of your project folder.\n\nIf the file is not found it will fallback to an internal `.htmlhintrc` found in `config` folder.\n\n___\n\n### Lint Sass\n\n```\nspeedy-build-tools lint-sass\n```\n\n| Option              | Description                                                           | Default Value           | Type                       |\n|---------------------|-----------------------------------------------------------------------|-------------------------|----------------------------|\n| `--config`, `-c`    | Lint rules file path                                                  | `.stylelintrc`          | string                     |\n| `--files`, `-f`     | Files to be linted - Supports glob patterns                           | `src/**/*.*(scss\\|sass)`| Array                      |\n| `--formatter`       | Formatter to use to format the linter results                         | `verbose`               | `json \\| verbose \\| string` |\n| `--fix`             | Determines whether to auto fix lint issues (which support fixing)     | `false`                 | boolean                    |\n| `--continueOnError` | Determines whether to exit with a non-zero status code on lint errors | `false`                 | boolean                    |\n\n#### Rules\nBy default, it will try to locate the `.stylelintrc` file in the root of your project folder.\n\nIf the file is not found it will fallback to an internal `.stylelintrc` found in `config` folder.\nThis file can also be used as a base for your rules.\n___\n\n### Lint TypeScript\n\n```\nspeedy-build-tools lint-ts\n```\n\n| Option              | Description                                                           | Default Value | Type                                                                                          |\n|---------------------|-----------------------------------------------------------------------|---------------|-----------------------------------------------------------------------------------------------|\n| `--config`, `-c`    | Lint rules file path                                                  | `tslint.json` | string                                                                                        |\n| `--program`, `-p`   | Path for tsconfig                                                     | `tsconfig.json`         | string                     |\n| `--files`, `-f`     | Files to be linted - Supports glob patterns                           | `src/**/*.ts` | Array                                                                                         |\n| `--formatter`       | Formatter to use to format the linter results                         | `stylish`     | `vso \\| verbose \\| prose \\| stylish \\| pmd \\| json \\| msbuild \\| fileList \\| codeFrame \\| checkstyle` |\n| `--fix`             | Determines whether to auto fix lint issues (which support fixing)     | `false`       | boolean                                                                                       |\n| `--continueOnError` | Determines whether to exit with a non-zero status code on lint errors | `false`       | boolean                                                                                       |\n\n#### Rules\nBy default, it will try to locate the `tslint.json` file in the root of your project folder.\n\nIf the file is not found it will fallback to an internal `tslint.json` found in `config` folder.\nThis file can also be used as a base for your rules.\n\n___\n\n### Global Options\n| Option            | Description            |\n|-------------------|------------------------|\n| `--debug`         | Show debug information |\n| `--help`, `-h`    | Show help              |\n| `--version`, `-v` | Show version number    |\n\nDisplay general help\n\n```\nspeedy-build-tools --help\n```\n\nDisplay help specific to a task:\n\n```\nspeedy-build-tools lint-sass --help\n```\n\nTo display help when running the task from a mapped npm script you should omit the `--`;\n\n```\nnpm run lint-sass help\n```\n\n## Stack\n\n- [Stylelint](https://github.com/stylelint/stylelint)\n- [Stylelint SCSS](https://github.com/kristerkari/stylelint-scss)\n- [TSLint](http://palantir.github.io/tslint)\n- [HTMLHint](https://github.com/yaniswang/HTMLHint)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falan-agius4%2Fspeedy-build-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falan-agius4%2Fspeedy-build-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falan-agius4%2Fspeedy-build-tools/lists"}