Skip to content

Commit 49f1aa0

Browse files
committed
Added 'is required' function comments as function docs
1 parent 300e4c2 commit 49f1aa0

File tree

2 files changed

+0
-15
lines changed

2 files changed

+0
-15
lines changed

main.go

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -170,67 +170,54 @@ func zipSource(source string, target string, testsPath string) error {
170170
}
171171

172172
func isRequired(path string, testsPath string) bool {
173-
// check for the `node_modules` and `bower_components` folders
174173
if IsNodeModules(path) || IsBowerComponents(path) {
175174
return false
176175
}
177176

178-
// check if it is a `test` path (i.e., a file that e.g. contains unit tests)
179177
if IsInTestFolder(path, testsPath) {
180178
return false
181179
}
182180

183-
// check for common test files (like .spec.js)
184181
if IsTestFile(path) {
185182
return false
186183
}
187184

188-
// check for style sheets (like .css and .scss)
189185
if IsStyleSheet(path) {
190186
return false
191187
}
192188

193-
// check for images (like .jpg, .png, .jpeg)
194189
if IsImage(path) {
195190
return false
196191
}
197192

198-
// check for documents (like .pdf, .md)
199193
if IsDocument(path) {
200194
return false
201195
}
202196

203-
// check for fonts (like .woff)
204197
if IsFont(path) {
205198
return false
206199
}
207200

208-
// check for the `.git` folder
209201
if IsGitFolder(path) {
210202
return false
211203
}
212204

213-
// check for the dbs (like .db, .sqlite3)
214205
if IsDb(path) {
215206
return false
216207
}
217208

218-
// check for the `build`, `dist` and `public` folders
219209
if IsBuildFolder(path) || IsDistFolder(path) || IsPublicFolder(path) {
220210
return false
221211
}
222212

223-
// check for IDE folder (like .code, .idea)
224213
if IsIdeFolder(path) {
225214
return false
226215
}
227216

228-
// check for video files
229217
if IsVideo(path) {
230218
return false
231219
}
232220

233-
// check for the "misc" not required stuff
234221
if IsMiscNotRequiredFile(path) {
235222
return false
236223
}

todo.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
- Add it to the NPM registry
22
- Add functionality to explicitly include certain files that my packager excludes (sample use case: `node_modules` may contain 2nd party code)
33
- Remove all .json that are not bower.json, package.json, package-lock.json
4-
5-
- Add all new features to the feature documentation in the README.md

0 commit comments

Comments
 (0)