Skip to content
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

Merged
merged 10 commits into from
Sep 4, 2023
Merged

Documentation #722

merged 10 commits into from
Sep 4, 2023

Conversation

mathieuLivebardon
Copy link
Contributor

@mathieuLivebardon mathieuLivebardon commented Aug 30, 2023

PR which adds dome doc:

  • prePublish command
  • jsdoc.js
  • NVM part in Developper.md
  • Comments of bin scripts

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.
Copy link
Contributor

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

console.log('Start reset');
exec('npm run reset')
const commandReset = `npm run reset`;
console.log('RUN', commandReset);
Copy link
Contributor

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

`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);
Copy link
Contributor

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo procosss

Copy link
Contributor Author

@mathieuLivebardon mathieuLivebardon Sep 4, 2023

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. 😶

@mathieuLivebardon mathieuLivebardon merged commit 23a8952 into master Sep 4, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants