https://github.com/sketch7/ssv-tools
frontend tooling for builds, lints etc...
https://github.com/sketch7/ssv-tools
configs hacktoberfest lint tools typescript
Last synced: 2 months ago
JSON representation
frontend tooling for builds, lints etc...
- Host: GitHub
- URL: https://github.com/sketch7/ssv-tools
- Owner: sketch7
- License: mit
- Created: 2016-12-12T19:40:54.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-09-08T00:53:30.000Z (about 2 years ago)
- Last Synced: 2024-12-02T18:59:51.418Z (10 months ago)
- Topics: configs, hacktoberfest, lint, tools, typescript
- Language: TypeScript
- Homepage:
- Size: 587 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[projectUri]: https://github.com/sketch7/ssv-tools
[projectGit]: https://github.com/sketch7/ssv-tools.git
[changeLog]: ./CHANGELOG.md
[contribWiki]: ./docs/CONTRIBUTION.md
[releaseWorkflowWiki]: ./docs/RELEASE-WORKFLOW.md
[npm]: https://www.npmjs.com
# @ssv/tools
[](https://github.com/sketch7/ssv-tools/actions/workflows/ci.yml)
[](https://badge.fury.io/js/%40ssv%2Ftools)
tools and utilities used for builds and develop sketch7 (ssv) libraries.
includes sharing of the following configs:
- `.eslintrc`
- `.stylelintrc`
- `tslint.json`
- `tsconfig.json`
In order to contribute please read the [Contribution guidelines][contribWiki].
**Quick links**
[Change logs][changeLog] | [Project Repository][projectUri] | [Contribution guidelines][contribWiki]
## Installation
Get library via [npm]
```bash
npm install @ssv/tools --save
```
## Usage
### API
```ts
import { compileTsc, rollup } from "@ssv/tools";
// compile typescript - execute typescript with cli
compileTsc({
module: "es2015",
configPath: "./tsconfig.build.json",
continueOnError: args.continueOnError
});
// rollup - execute rollup with cli
rollup({ continueOnError: args.continueOnError });
// prepare for prepublish, as copy files such as `README.md`, `CHANGELOG.md`, copy and transform `package.json`
buildResources();
// prepare release build such as update version placeholder
prepareReleaseBuild();
```
#### gulp utils
```ts
import { setGulpContext, registerGulpMultiTargetBuilds } from "@ssv/tools";
import gulp from "gulp";
// before geting started with gulp utils, you need to invoke this once in order to share same instance of gulp.
setGulpContext(gulp)
// generates and register task for gulp by convention for multi-targetting build e.g. amd, umd, es2015 etc...
// e.g. compile:styles (all) | compile:styles:dev (dev target) | compile:styles:TARGET etc... (compile:styles:es2015).
registerGulpMultiTargetBuilds({
taskName: "html",
action: compileHtml,
config: {
buildTargets: [
"es2015",
"amd",
"umd"
],
devTarget: "amd",
}
});
```
#### ES5
for usage with es5, use as following:
```ts
const ssvTools = require("@ssv/tools");
ssvTools.compileTsc(...);
```
### Base configs
#### eslint
```json
{
"extends": "./node_modules/@ssv/tools/config/.eslintrc"
}
```
#### tslint
```json
{
"extends": [
"./node_modules/@ssv/tools/config/tslint.json"
]
}
```
#### tsconfig
```json
{
"extends": "./node_modules/@ssv/tools/config/tsconfig.json"
}
```
#### stylelint
```json
{
"extends": "./node_modules/@ssv/tools/config/.stylelintrc"
}
```
## Getting Started
### Setup Machine for Development
Install/setup the following:
- NodeJS v18+
- Visual Studio Code or similar code editor
- TypeScript 5.0+
- Git + SourceTree, SmartGit or similar (optional)
- Ensure to install **global NPM modules** using the following:
```bash
npm install -g git gulp
```
#### Cloning Repo
- Run `git clone https://github.com/sketch7/ssv-tools.git`
### Project Setup
The following process need to be executed in order to get started.
```bash
npm install
```
### Building the code
```bash
npm run build
```