@yamato-daiwa/automation 0.0.0 → 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +169 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# Yamato-Daiwa Automation 〔YDA〕
|
|
2
|
+
|
|
3
|
+
The project building tool with declarative YAML configuration based on Gulp and Webpack.
|
|
4
|
+
Specializing on Pug, Stylus and TypeScript as source code languages; also works with images, fonts, videos and audios.
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
[📖 Documentation](https://github.com/TokugawaTakeshi/Yamato-Daiwa-Automation/blob/master/README.md)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## Dependencies list
|
|
12
|
+
|
|
13
|
+
<dl>
|
|
14
|
+
|
|
15
|
+
<dt>@vue/compiler-sfc, vue, vue-loader</dt>
|
|
16
|
+
<dd>Used to provide the support of Vue Single File Components for ECMAScript logic processing</dd>
|
|
17
|
+
|
|
18
|
+
<dt>@yamato-daiwa/es-extensions, @yamato-daiwa/es-extensions-nodejs</dt>
|
|
19
|
+
<dd>Used to reduce the routine code</dd>
|
|
20
|
+
|
|
21
|
+
<dt>@yamato-daiwa/style_guides</dt>
|
|
22
|
+
<dd>The code style guides to which this project obeying and also suggested for consuming project.</dd>
|
|
23
|
+
|
|
24
|
+
<dt>autoprefixer</dt>
|
|
25
|
+
<dd>Used for adding of the vendor prefixes to CSS properties in processed stylesheets the better cross-browser adaptations</dd>
|
|
26
|
+
|
|
27
|
+
<dt>browser-sync</dt>
|
|
28
|
+
<dd>Used to provide the automation of browser reloading when project incrementally rebuilt</dd>
|
|
29
|
+
|
|
30
|
+
<dt>cheerio</dt>
|
|
31
|
+
<dd>Used for manipulation with compiled HTML code like resolving of paths aliases</dd>
|
|
32
|
+
|
|
33
|
+
<dt>css-loader</dt>
|
|
34
|
+
<dd>Used to provide the imports of stylesheets to ECMAScript bundles</dd>
|
|
35
|
+
|
|
36
|
+
<dt>cssnano</dt>
|
|
37
|
+
<dd>Used to provide optimization and minification of compiled CSS code</dd>
|
|
38
|
+
|
|
39
|
+
<dt>eslint-webpack-plugin</dt>
|
|
40
|
+
<dd>Used to provide the ESLint inspection with output to terminal during processing of ECMAScript logic</dd>
|
|
41
|
+
|
|
42
|
+
<dt>fork-ts-checker-webpack-plugin</dt>
|
|
43
|
+
<dd>Used to improve the performance of TypeScript transpiling functionality</dd>
|
|
44
|
+
|
|
45
|
+
<dt>gulp</dt>
|
|
46
|
+
<dd>Used as main task manager, the tool to provide the arranging of the tasks to sequences and series and running them</dd>
|
|
47
|
+
|
|
48
|
+
<dt>gulp-debug</dt>
|
|
49
|
+
<dd>Used to outputs the processed files names and quantity to the terminal</dd>
|
|
50
|
+
|
|
51
|
+
<dt>gulp-html-prettify</dt>
|
|
52
|
+
<dd>Used to provide the formatting of output HTML code better than suggested by Pug pre-processor</dd>
|
|
53
|
+
|
|
54
|
+
<dt>gulp-if</dt>
|
|
55
|
+
<dd>Used for providing of conditional processing according to various settings</dd>
|
|
56
|
+
|
|
57
|
+
<dt>gulp-imagemin</dt>
|
|
58
|
+
<dd>Used to provide the automation of images files optimization</dd>
|
|
59
|
+
|
|
60
|
+
<dt>gulp-intercept</dt>
|
|
61
|
+
<dd>Used for defining of configuration-dependent logic inside Gulp pipelines</dd>
|
|
62
|
+
|
|
63
|
+
<dt>gulp-plumber</dt>
|
|
64
|
+
<dd>Used for errors handing inside Gulp pipelines</dd>
|
|
65
|
+
|
|
66
|
+
<dt>gulp-postcss</dt>
|
|
67
|
+
<dd>Used to provide the post-processing of CSS code with PostCSS plugins</dd>
|
|
68
|
+
|
|
69
|
+
<dt>gulp-pug</dt>
|
|
70
|
+
<dd>Used to provide the basic Pug-to-HTML transpiling</dd>
|
|
71
|
+
|
|
72
|
+
<dt>gulp-stylus</dt>
|
|
73
|
+
<dd>Used to provide the basic Stylus-to-CSS transpiling</dd>
|
|
74
|
+
|
|
75
|
+
<dt>html-loader</dt>
|
|
76
|
+
<dd>Used to provide the import of HTML code as string to JavaScript bundle</dd>
|
|
77
|
+
|
|
78
|
+
<dt>html-validator</dt>
|
|
79
|
+
<dd>Used to get the HTML validation data from W3C service. The formatted output to terminal has been implemented by YDA developer.</dd>
|
|
80
|
+
|
|
81
|
+
<dt>imagemin-pngquant</dt>
|
|
82
|
+
<dd>Used to provides the optimization of PNG files</dd>
|
|
83
|
+
|
|
84
|
+
<dt>json5-loader</dt>
|
|
85
|
+
<dd>Used to provide the imports of JSON5 as ECMAScript native object to JavaScript bundle</dd>
|
|
86
|
+
|
|
87
|
+
<dt>node-notifier</dt>
|
|
88
|
+
<dd>Used for accessing to native toast message functionality</dd>
|
|
89
|
+
|
|
90
|
+
<dt>pug-plain-loader</dt>
|
|
91
|
+
<dd>Used to providing of the Pug source code language for Vue templates in Single File Components</dd>
|
|
92
|
+
|
|
93
|
+
<dt>pug-html-loader</dt>
|
|
94
|
+
<dd>
|
|
95
|
+
Used in combination with <b>html-loader</b> to provide the importing of HTML code compiled from Pug language as string
|
|
96
|
+
to JavaScript bundle.
|
|
97
|
+
</dd>
|
|
98
|
+
|
|
99
|
+
<dt>rev-hash</dt>
|
|
100
|
+
<dd>
|
|
101
|
+
Used for generating of file content dependent postfixes to prevent the outdated stylesheets, scripts etc.
|
|
102
|
+
because of browser caching (thus actual for the Browser runtime only).
|
|
103
|
+
</dd>
|
|
104
|
+
|
|
105
|
+
<dt>stlint</dt>
|
|
106
|
+
<dd>Used for linting of styles written by Stylus. The formatted output to terminal has been implemented by YDA developer</dd>
|
|
107
|
+
|
|
108
|
+
<dd>style-loader</dd>
|
|
109
|
+
<dt>Used to provide the dynamic injection of CSS functionality which has been imported to JavaScript bundle built by Webpack</dt>
|
|
110
|
+
|
|
111
|
+
<dt>stylus-loader</dt>
|
|
112
|
+
<dd>
|
|
113
|
+
Used to provide the dynamic injection of CSS witten by Stylus pre-processor which has been imported to JavaScript
|
|
114
|
+
bundle built by Webpack
|
|
115
|
+
</dd>
|
|
116
|
+
|
|
117
|
+
<dt>ts-loader</dt>
|
|
118
|
+
<dd>Used to provide the integration of TypeScript and Webpack</dd>
|
|
119
|
+
|
|
120
|
+
<dt>vue-style-loader</dt>
|
|
121
|
+
<dd>Used to provide the dynamical injection of CSS written in Vue Single File Components to HTML document</dd>
|
|
122
|
+
|
|
123
|
+
<dt>webpack</dt>
|
|
124
|
+
<dd>Used as basic tool for the ECMAScript logic processing.</dd>
|
|
125
|
+
|
|
126
|
+
<dt>webpack-node-externals</dt>
|
|
127
|
+
<dd>
|
|
128
|
+
Used to prevent the bundling of NodeJS modules by Webpack because this bundling brings a lot of warning and/or errors
|
|
129
|
+
while not required for console and server applications.
|
|
130
|
+
</dd>
|
|
131
|
+
|
|
132
|
+
<dt>yaml-loader</dt>
|
|
133
|
+
<dd>Used to provide the import of content of YAML files converted to JavaScript native object.</dd>
|
|
134
|
+
|
|
135
|
+
</dl>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
### For development needs only
|
|
139
|
+
|
|
140
|
+
All **@types** are the TypeScript types definitions required for normal transpiling of the TypeScript.
|
|
141
|
+
|
|
142
|
+
<dl>
|
|
143
|
+
|
|
144
|
+
<dt>ts-node</dt>
|
|
145
|
+
<dd>Used to support the Webpack building written by TypeScript</dd>
|
|
146
|
+
|
|
147
|
+
<dt>typescript</dt>
|
|
148
|
+
<dd>Used to provide the TypeScript as source code language.</dd>
|
|
149
|
+
|
|
150
|
+
<dt>webpack-cli</dt>
|
|
151
|
+
<dd>Used for the project building.</dd>
|
|
152
|
+
|
|
153
|
+
</dl>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
### Temporary dependencies
|
|
157
|
+
|
|
158
|
+
<dl>
|
|
159
|
+
|
|
160
|
+
<dt>glob</dt>
|
|
161
|
+
<dd>Used by <b>ImprovedGlob</b> which will be moved to <b>@yamato-daiwa/es-extensions-nodejs</b> and used as dependency.</dd>
|
|
162
|
+
|
|
163
|
+
<dt>json5</dt>
|
|
164
|
+
<dd>Used by <b>ConsoleCommandsParser</b> which will be moved to <b>@yamato-daiwa/es-extensions-nodejs</b> and used as dependency.</dd>
|
|
165
|
+
|
|
166
|
+
<dt>yamljs</dt>
|
|
167
|
+
<dd>Used for reading and parsing of YAML files. Will be moved to <b>@yamato-daiwa/es-extensions-nodejs</b> and used as dependency.</dd>
|
|
168
|
+
|
|
169
|
+
</dl>
|