Skip to content

Commit a6b66dc

Browse files
phatedphated
committed
feat: Implement all messages
1 parent b25241f commit a6b66dc

File tree

5 files changed

+140
-14
lines changed

5 files changed

+140
-14
lines changed

‎LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2021-2023 Blaine Bublitz <blaine.bublitz@gmail.com> and Eric Schoffstall <yo@contra.io>.
3+
Copyright (c) 2024 Blaine Bublitz <blaine.bublitz@gmail.com> and Eric Schoffstall <yo@contra.io>.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,40 @@
88

99
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Coveralls Status][coveralls-image]][coveralls-url]
1010

11-
PROJECT_DESCRIPTION
11+
Symbols for all messages within gulp-cli.
1212

1313
## Usage
1414

15+
In your `.gulp.js` file:
16+
1517
```js
18+
var messages = require('@gulpjs/messages');
19+
20+
module.exports = {
21+
message: function (data) {
22+
if (data.tag === messages.DESCRIPTION) {
23+
return 'Your description override message';
24+
}
25+
}
26+
};
1627
```
1728

1829
## API
1930

31+
This project exposes various symbols assigned to keys to use for matching gulp-cli messages.
32+
2033
## License
2134

2235
MIT
2336

2437
<!-- prettier-ignore-start -->
25-
[downloads-image]: https://img.shields.io/npm/dm/$PROJECT_NAME.svg?style=flat-square
26-
[npm-url]: https://www.npmjs.com/package/$PROJECT_NAME
27-
[npm-image]: https://img.shields.io/npm/v/$PROJECT_NAME.svg?style=flat-square
38+
[downloads-image]: https://img.shields.io/npm/dm/%40gulpjs/messages.svg?style=flat-square
39+
[npm-url]: https://www.npmjs.com/package/%40gulpjs/messages
40+
[npm-image]: https://img.shields.io/npm/v/%40gulpjs/messages.svg?style=flat-square
2841

29-
[ci-url]: https://github.com/gulpjs/$PROJECT_NAME/actions?query=workflow:dev
30-
[ci-image]: https://img.shields.io/github/actions/workflow/status/gulpjs/$PROJECT_NAME/dev.yml?branch=master&style=flat-square
42+
[ci-url]: https://github.com/gulpjs/%40gulpjs/messages/actions?query=workflow:dev
43+
[ci-image]: https://img.shields.io/github/actions/workflow/status/gulpjs/%40gulpjs/messages/dev.yml?branch=master&style=flat-square
3144

32-
[coveralls-url]: https://coveralls.io/r/gulpjs/$PROJECT_NAME
33-
[coveralls-image]: https://img.shields.io/coveralls/gulpjs/$PROJECT_NAME/master.svg?style=flat-square
45+
[coveralls-url]: https://coveralls.io/r/gulpjs/%40gulpjs/messages
46+
[coveralls-image]: https://img.shields.io/coveralls/gulpjs/%40gulpjs/messages/master.svg?style=flat-square
3447
<!-- prettier-ignore-end -->

‎index.js

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
'use strict';
2+
3+
module.exports = {
4+
/**
5+
* Liftoff events
6+
*/
7+
PRELOAD_BEFORE: Symbol.for('GULP_CLI_PRELOAD_BEFORE'),
8+
PRELOAD_SUCCESS: Symbol.for('GULP_CLI_PRELOAD_SUCCESS'),
9+
PRELOAD_FAILURE: Symbol.for('GULP_CLI_PRELOAD_FAILURE'),
10+
LOADER_SUCCESS: Symbol.for('GULP_CLI_LOADER_SUCCESS'),
11+
LOADER_FAILURE: Symbol.for('GULP_CLI_LOADER_FAILURE'),
12+
NODE_FLAGS: Symbol.for('GULP_CLI_NODE_FLAGS'),
13+
RESPAWNED: Symbol.for('GULP_CLI_RESPAWNED'),
14+
15+
/**
16+
* Various problems that might occur
17+
*/
18+
UNSUPPORTED_GULP_VERSION: Symbol.for('GULP_CLI_UNSUPPORTED_GULP_VERSION'),
19+
MISSING_GULPFILE: Symbol.for('GULP_CLI_MISSING_GULPFILE'),
20+
MISSING_NODE_MODULES: Symbol.for('GULP_CLI_MISSING_NODE_MODULES'),
21+
MISSING_GULP: Symbol.for('GULP_CLI_MISSING_GULP'),
22+
YARN_INSTALL: Symbol.for('GULP_CLI_YARN_INSTALL'),
23+
NPM_INSTALL: Symbol.for('GULP_CLI_NPM_INSTALL'),
24+
YARN_INSTALL_GULP: Symbol.for('GULP_CLI_YARN_INSTALL_GULP'),
25+
NPM_INSTALL_GULP: Symbol.for('GULP_CLI_NPM_INSTALL_GULP'),
26+
27+
/**
28+
* Other details
29+
*/
30+
CWD_CHANGED: Symbol.for('GULP_CLI_CWD_CHANGED'),
31+
DESCRIPTION: Symbol.for('GULP_CLI_DESCRIPTION'),
32+
GULPFILE: Symbol.for('GULP_CLI_GULPFILE'),
33+
34+
/**
35+
* Task system
36+
*/
37+
TASK_START: Symbol.for('GULP_CLI_TASK_START'),
38+
TASK_STOP: Symbol.for('GULP_CLI_TASK_STOP'),
39+
TASK_FAILURE: Symbol.for('GULP_CLI_TASK_FAILURE'),
40+
TASK_MISSING: Symbol.for('GULP_CLI_TASK_MISSING'),
41+
TASK_SYNC: Symbol.for('GULP_CLI_TASK_SYNC'),
42+
43+
/**
44+
* Completions
45+
*/
46+
COMPLETION_TYPE_MISSING: Symbol.for('GULP_CLI_COMPLETION_TYPE_MISSING'),
47+
COMPLETION_TYPE_UNKNOWN: Symbol.for('GULP_CLI_COMPLETION_TYPE_UNKNOWN'),
48+
49+
/**
50+
* Errors
51+
*/
52+
PRELOAD_ERROR: Symbol.for('GULP_CLI_PRELOAD_ERROR'),
53+
LOADER_ERROR: Symbol.for('GULP_CLI_LOADER_ERROR'),
54+
ARGV_ERROR: Symbol.for('GULP_CLI_ARGV_ERROR'),
55+
EXEC_ERROR: Symbol.for('GULP_CLI_EXEC_ERROR'),
56+
TASK_ERROR: Symbol.for('GULP_CLI_TASK_ERROR'),
57+
58+
/**
59+
* Help
60+
*/
61+
USAGE: Symbol.for('GULP_CLI_USAGE'),
62+
FLAG_HELP: Symbol.for('GULP_CLI_FLAG_HELP'),
63+
FLAG_VERSION: Symbol.for('GULP_CLI_FLAG_VERSION'),
64+
FLAG_PRELOAD: Symbol.for('GULP_CLI_FLAG_PRELOAD'),
65+
FLAG_GULPFILE: Symbol.for('GULP_CLI_FLAG_GULPFILE'),
66+
FLAG_CWD: Symbol.for('GULP_CLI_FLAG_CWD'),
67+
FLAG_TASKS: Symbol.for('GULP_CLI_FLAG_TASKS'),
68+
FLAG_TASKS_SIMPLE: Symbol.for('GULP_CLI_FLAG_TASKS_SIMPLE'),
69+
FLAG_TASKS_JSON: Symbol.for('GULP_CLI_FLAG_TASKS_JSON'),
70+
FLAG_TASKS_DEPTH: Symbol.for('GULP_CLI_FLAG_TASKS_DEPTH'),
71+
FLAG_COMPACT_TASKS: Symbol.for('GULP_CLI_FLAG_COMPACT_TASKS'),
72+
FLAG_SORT_TASKS: Symbol.for('GULP_CLI_FLAG_SORT_TASKS'),
73+
FLAG_COLOR: Symbol.for('GULP_CLI_FLAG_COLOR'),
74+
FLAG_NO_COLOR: Symbol.for('GULP_CLI_FLAG_NO_COLOR'),
75+
FLAG_SILENT: Symbol.for('GULP_CLI_FLAG_SILENT'),
76+
FLAG_CONTINUE: Symbol.for('GULP_CLI_FLAG_CONTINUE'),
77+
FLAG_SERIES: Symbol.for('GULP_CLI_FLAG_SERIES'),
78+
FLAG_LOG_LEVEL: Symbol.for('GULP_CLI_FLAG_LOG_LEVEL'),
79+
80+
/**
81+
* Task tree
82+
*/
83+
TASK_NAME: Symbol.for('GULP_CLI_TASK_NAME'),
84+
TASK_DESCRIPTION: Symbol.for('GULP_CLI_TASK_DESCRIPTION'),
85+
TASK_FLAG: Symbol.for('GULP_CLI_TASK_FLAG'),
86+
TASK_FLAG_DESCRIPTION: Symbol.for('GULP_CLI_TASK_FLAG_DESCRIPTION'),
87+
BOX_DRAWINGS_LIGHT_UP_AND_RIGHT: Symbol.for('GULP_CLI_BOX_DRAWINGS_LIGHT_UP_AND_RIGHT'),
88+
BOX_DRAWINGS_LIGHT_VERTICAL_AND_RIGHT: Symbol.for('GULP_CLI_BOX_DRAWINGS_LIGHT_VERTICAL_AND_RIGHT'),
89+
BOX_DRAWINGS_LIGHT_HORIZONTAL: Symbol.for('GULP_CLI_BOX_DRAWINGS_LIGHT_HORIZONTAL'),
90+
BOX_DRAWINGS_LIGHT_DOWN_AND_HORIZONTAL: Symbol.for('GULP_CLI_BOX_DRAWINGS_LIGHT_DOWN_AND_HORIZONTAL'),
91+
BOX_DRAWINGS_LIGHT_VERTICAL: Symbol.for('GULP_CLI_BOX_DRAWINGS_LIGHT_VERTICAL'),
92+
};

‎package.json

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
{
2-
"name": "",
3-
"version": "",
4-
"description": "",
2+
"name": "@gulpjs/messages",
3+
"version": "0.0.0",
4+
"description": "Symbols for all messages within gulp-cli",
55
"author": "Gulp Team <team@gulpjs.com> (https://gulpjs.com/)",
6-
"contributors": [],
7-
"repository": "",
6+
"contributors": [
7+
"Blaine Bublitz <blaine.bublitz@gmail.com>"
8+
],
9+
"repository": "gulpjs/messages",
810
"license": "MIT",
911
"engines": {
1012
"node": ">=10.13.0"
@@ -37,5 +39,8 @@
3739
"prettier": {
3840
"singleQuote": true
3941
},
42+
"publishConfig": {
43+
"access": "public"
44+
},
4045
"keywords": []
4146
}

‎test/index.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
'use strict';
2+
3+
var expect = require('expect');
4+
5+
var messages = require('../index.js');
6+
7+
describe('messages', function () {
8+
it('does not have a duplicate symbol', function (done) {
9+
var seen = new Set();
10+
Object.values(messages).forEach(function (symbol) {
11+
expect(seen.has(symbol)).toEqual(false);
12+
seen.add(symbol);
13+
});
14+
done();
15+
});
16+
});

0 commit comments

Comments
 (0)