-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation #722
Documentation #722
Conversation
bin/backEnd.js
Outdated
/** | ||
* @file Sets up an Express backend server for examples, serving static files, | ||
* replacing HTML strings, and enabling a game socket service. | ||
* The behavior adapts based on the environment mode and uses package.json configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe you could refer to cross-env to explain the environment mode like => see cross-env
bin/prePublish.js
Outdated
console.log('Start reset'); | ||
exec('npm run reset') | ||
const commandReset = `npm run reset`; | ||
console.log('RUN', commandReset); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
instead of "RUN" "exec" seems more appropiate
bin/prePublish.js
Outdated
`git describe --tags --match v* --abbrev=0 | xargs -I tag sh -c 'git log tag..HEAD --pretty=format:%s > ./docs/static/ChangelogDiff.txt'` | ||
).then(() => { | ||
const commandGenerateChangelog = `git describe --tags --match v* --abbrev=0 | xargs -I tag sh -c 'git log tag..HEAD --pretty=format:%s > ./docs/static/ChangelogDiff.txt'`; | ||
console.log('RUN', commandGenerateChangelog); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
idem
* @requires {@link https://www.npmjs.com/package/@ud-viz/shared|@ud-viz/shared} | ||
* @requires {@link https://www.npmjs.com/package/reload|reload} | ||
* @requires {@link https://www.npmjs.com/package/string-replace-middleware|string-replace-middleware} | ||
* The behavior adapts based on the environment mode (NODE_ENV) inject in procosss.env with cross-env package. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo procosss
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I went too fast to merge the branch I had not seen the comment. I fixed it in this new PR. 😶
PR which adds dome doc: