Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tokugawatakeshi/yamato-daiwa-automation
The tool for the full-stack web application building and deploying specializing on Pug, Stylus and TypeScirpt as source code languages.
https://github.com/tokugawatakeshi/yamato-daiwa-automation
build-tool pug stylus typescript
Last synced: about 2 months ago
JSON representation
The tool for the full-stack web application building and deploying specializing on Pug, Stylus and TypeScirpt as source code languages.
- Host: GitHub
- URL: https://github.com/tokugawatakeshi/yamato-daiwa-automation
- Owner: TokugawaTakeshi
- Created: 2021-08-07T01:17:47.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-09T02:40:14.000Z (about 2 months ago)
- Last Synced: 2024-11-09T03:17:46.972Z (about 2 months ago)
- Topics: build-tool, pug, stylus, typescript
- Language: TypeScript
- Homepage:
- Size: 6.86 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Yamato Daiwa Automation 〔 YDA 〕
The project building tool with declarative YAML configuration based on Gulp and Webpack.
Specializing on Pug, Stylus and TypeScript as source code languages; also works with images, fonts, videos and audios.
Could be used for development of websites, web applications, console utilities and libraries.
## Installation
```
npm i @yamato-daiwa/automation -D -E
```
## Required terminology
Please familiarize with the YDF terminology because it is being used in documentation.
[📖 Terminology reference](TemporaryDocumentation/Terminology/Terminology.english.md)
## Conceptions
* [📖 Resolving of path to resources](TemporaryDocumentation/Functionality/Shared/ResourcesPathsResolving/ResourcesPathsResolving.english.md)
## API
### Configuration file
**YDA** required the configuration filed.
As default, **yda.config.yaml** file will be searched in the project root directory.
* [Common settings](TemporaryDocumentation/API/ConfigurationFile/CommonSettings/CommonSettings.english.md)
* [Markup processing settings](TemporaryDocumentation/API/ConfigurationFile/Markup/MarkupProcessing.english.md)
* [Styles processing settings](TemporaryDocumentation/API/ConfigurationFile/Styles/StylesProcessing.md)
* [ECMAScript logic processing settings](TemporaryDocumentation/API/ConfigurationFile/ECMA_ScriptProcessing/ECMA_ScriptProcessing.md)
* [Plain copying](TemporaryDocumentation/API/ConfigurationFile/PlainCopying/PlainCopying.md)
[//]: # (// TODO )
* [Assets processing settings](TemporaryDocumentation/AssetsProcessing.md)
* [Browser live reloading settings](TemporaryDocumentation/API/ConfigurationFile/BrowserLiveReloading/BrowserLiveReloading.english.md)
### Console
```bash
yda build
```
#### Parameters
##### mode
- Type
- string
- Is required
- YES
- Shortcut
- m
- Allowed alternatives
-
- STATIC_PREVIEW
- LOCAL_DEVELOPMENT
- TESTING
- STAGING
- PRODUCTION
The project building mode; affecting on, for example, output directory or code minification.
See **buildingModeDependent** configuration of each task.
```bash
yda build --mode LOCAL_DEVELOPMENT
```
### configurationFile
- Type
- string
- Default value
- yda.config.yaml
The relative path to configuration file.
The file name extension ("yaml" of "yml") could be omitted.
```bash
yda build --configurationFile automation.yaml --mode DEVELOPMENT
```
### selectiveExecution
- Type
- string
- Is required
- NO
The ID of selective execution which must be defined in configuration file if to use this option.
```bash
yda build --selectiveExecution StaticPreview --mode DEVELOPMENT
```
### Vulnerabilities
Depending on Gulp, pre-processors and other utils, YDA inherits theirs vulnerabilities.
Once these vulnerabilities will be fixed in dependencies, it will be fixed in YDA.
The most problematic packages are:
* gulp
* access-sniff