@pokusio/hugo-gmented-gulp NPM

Why this npm package ?

I want a Gulpfile written in TypeScript, to manage he build of the @pokusio/npx-hugo-gmented module at root of this repository

I therefore needed also a full TypeScript configuration, which I automated using npm scripts, and to which i added a very classical eslint/prettier configuration

Finally my conclusion is that :

if we do a NodeJS TypeScript project :
- a project which source code is in TypeScript language
- a project which will be executed in a NodeJS environment version v16.13.0 (output of node -v)
Then :
- the --module option must be commonjs,
- while i can have --target to any Recent EcmaScript version, like --target es2022, or even --target es2022,
- the modularization technology which wil be used in generated code will still be comonjs because of the --module option's value (commenjs).

Indeed, the bottom line in starting a new TypeScript project, is to keep in mind, that if the execution env is NodeJS, then :

it will be possible, but very difficult to use ESM modules in the generated JavaScript :
- About how complex it is to make a "pure ESM NodeJS TypeScript project" : https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c#faq
- About the issue that happens when NodeJS + --module es2022 (or module is any ESM version) + TypeScript : https://docs.joshuatz.com/cheatsheets/node-and-npm/node-esm/#typescript---fully-resolved-import-filepaths-with-extensions
About the difference between --target and --module (so much the bottom question when starting a new typescript project...) :

All those thoughts and clarifications gave me in the end that way to generate my tsconfig.json :

npx tsc --init --rootDir ./src/ --outDir ./bin/ \
 --target "es2022" --module "commonjs" --moduleResolution nodenext \
 --noImplicitAny true --experimentalDecorators true \
 --esModuleInterop true --resolveJsonModule true

The very particularity of this newly built Gulpfile, is that it has modularization capabilities : the GulpFile may be structured from multiple TypeScript files, actually from a fully fledged TypeScript project.

Indeed, you will see in the npm run dev script, that the resulting Gulpfile can be executed from the ./.gulp/bin/gulpfile.js : gulp -f ./.gulp/bin/gulpfile.js

How to build this npm package

export DESISRED_VERSION="feature/init-npx-project"
git clone git@github.com:pokusio/npx-hugo-gmented.git
cd npx-hugo-gmented/
git checkout ${DESISRED_VERSION}

cd ./.gulp/
npm i
npm run dev

How to publish npm package :

export DESISRED_VERSION="feature/init-npx-project"
git clone git@github.com:pokusio/npx-hugo-gmented.git
cd npx-hugo-gmented/
git checkout ${DESISRED_VERSION}

cd ./.gulp/

npm i
npm run dev

npm publish --access public
# ---
# I made a first test publish using an ACCES TOKEN in my  ~/.npmrc  file :
# it published https://www.npmjs.com/package/@pokusio/hugo-gmented-gulp
#  - I verified it is not the account linked to the jean.baptiste.lasselle@gmail.com
# ---
#   :~/hugo-gmented/npx-hugo-gmented/.gulp$ npm whoamipokusio
#   :~/hugo-gmented/npx-hugo-gmented/.gulp$ npm profile get
#   ┌─────────────────┬─────────────────────────────────────────┐
#   │ name            │ pokusio                                 │
#   ├─────────────────┼─────────────────────────────────────────┤
#   │ email           │ bumbebee.pokus.bot@gmail.com (verified) │
#   ├─────────────────┼─────────────────────────────────────────┤
#   │ two-factor auth │ disabled                                │
#   ├─────────────────┼─────────────────────────────────────────┤
#   │ fullname        │                                         │
#   ├─────────────────┼─────────────────────────────────────────┤
#   │ homepage        │                                         │
#   ├─────────────────┼─────────────────────────────────────────┤
#   │ freenode        │                                         │
#   ├─────────────────┼─────────────────────────────────────────┤
#   │ twitter         │                                         │
#   ├─────────────────┼─────────────────────────────────────────┤
#   │ github          │                                         │
#   ├─────────────────┼─────────────────────────────────────────┤
#   │ created         │ 2022-01-19T01:59:54.022Z                │
#   ├─────────────────┼─────────────────────────────────────────┤
#   │ updated         │ 2022-01-19T01:59:54.017Z                │
#   └─────────────────┴─────────────────────────────────────────┘

I had there a big problem :
- I still had a Token which worked in my ~/.npmrc
- But the verified email address I had configured in my profile did not exist anymore (I had deleted as a google account)
But fortunately, there is a way to change the email address from the CLI, authenticating with the ~/.npmrc :

:~/hugo-gmented/npx-hugo-gmented/.gulp$ npm profile set email bumblebee.pokus.bot@gmail.com
Set email to bumblebee.pokus.bot@gmail.com
:~/hugo-gmented/npx-hugo-gmented/.gulp$ npm profile get
┌─────────────────┬───────────────────────────────────────────┐
│ name            │ pokusio                                   │
├─────────────────┼───────────────────────────────────────────┤
│ email           │ bumblebee.pokus.bot@gmail.com(unverified) │
├─────────────────┼───────────────────────────────────────────┤
│ two-factor auth │ disabled                                  │
├─────────────────┼───────────────────────────────────────────┤
│ fullname        │                                           │
├─────────────────┼───────────────────────────────────────────┤
│ homepage        │                                           │
├─────────────────┼───────────────────────────────────────────┤
│ freenode        │                                           │
├─────────────────┼───────────────────────────────────────────┤
│ twitter         │                                           │
├─────────────────┼───────────────────────────────────────────┤
│ github          │                                           │
├─────────────────┼───────────────────────────────────────────┤
│ created         │ 2022-01-19T01:59:54.022Z                  │
├─────────────────┼───────────────────────────────────────────┤
│ updated         │ 2022-06-05T07:59:10.605Z                  │
└─────────────────┴───────────────────────────────────────────┘

I finally requested from https://npmjs.com website a password reset for user pokusio, and there i received the password reset in my new email address, and from there could change to a new password, and login again with my pokusio user
From the webui, I finally renamed my user io-pokus, turned pokusio into an organization, and then my Token in the ~/.npmrc was no longer valid, so i logged out and logged back in again using the new user name io-pokus :

:~/hugo-gmented/npx-hugo-gmented/.gulp$ npm logout
:~/hugo-gmented/npx-hugo-gmented/.gulp$ npm login
npm notice Log in on https://registry.npmjs.org/
Username: io-pokus
Password:
Email: (this IS public) bumblebee.pokus.bot@gmail.com
npm notice Please check your email for a one-time password (OTP)
Enter one-time password: 78212629
Logged in as io-pokus on https://registry.npmjs.org/.
:~/hugo-gmented/npx-hugo-gmented/.gulp$ npm profile get
┌─────────────────┬──────────────────────────────────────────┐
│ name            │ io-pokus                                 │
├─────────────────┼──────────────────────────────────────────┤
│ email           │ bumblebee.pokus.bot@gmail.com (verified) │
├─────────────────┼──────────────────────────────────────────┤
│ two-factor auth │ disabled                                 │
├─────────────────┼──────────────────────────────────────────┤
│ fullname        │                                          │
├─────────────────┼──────────────────────────────────────────┤
│ homepage        │                                          │
├─────────────────┼──────────────────────────────────────────┤
│ freenode        │                                          │
├─────────────────┼──────────────────────────────────────────┤
│ twitter         │                                          │
├─────────────────┼──────────────────────────────────────────┤
│ github          │                                          │
├─────────────────┼──────────────────────────────────────────┤
│ created         │ 2022-06-05T08:09:51.438Z                 │
├─────────────────┼──────────────────────────────────────────┤
│ updated         │ 2022-06-05T08:09:51.438Z                 │
└─────────────────┴──────────────────────────────────────────┘

And there I was back in business, rotating my secrets

How to re-generate this project

# export WHERE_WE_REGENERATE_PROJECT="$(pwd)/lets-regen"
export WHERE_WE_REGENERATE_PROJECT=$(mktemp -d -t "WHERE_WE_REGENERATE_PROJECT_XXXXXX")
export WHERE_WE_RETRIEVE_PROJECT_ASSETS=$(mktemp -d -t "WHERE_WE_RETRIEVE_PROJECT_ASSETS_XXXXXX")

echo " Checks : WHERE_WE_REGENERATE_PROJECT=[${WHERE_WE_REGENERATE_PROJECT}]"
echo " Checks : WHERE_WE_RETRIEVE_PROJECT_ASSETS=[${WHERE_WE_RETRIEVE_PROJECT_ASSETS}]"
ls -alh ${WHERE_WE_REGENERATE_PROJECT}/
echo " >>>>>>>>>>>>>>>>>> "
ls -alh ${WHERE_WE_RETRIEVE_PROJECT_ASSETS}/




export DESISRED_VERSION="feature/init-npx-project"
export DESISRED_VERSION="0.0.0-alpha"
git clone git@github.com:pokusio/npx-hugo-gmented.git
cd ${WHERE_WE_RETRIEVE_PROJECT_ASSETS}
git checkout ${DESISRED_VERSION}

# retrieving files we need
cp ./.gulp/package.json ${WHERE_WE_REGENERATE_PROJECT}/
cp ./.gulp/package-lock.json ${WHERE_WE_REGENERATE_PROJECT}/
mkdir -p  ${WHERE_WE_REGENERATE_PROJECT}/.npm.scripts/
cp -fR ./.gulp/.npm.scripts/* ${WHERE_WE_REGENERATE_PROJECT}/.npm.scripts/
chmod +x ${WHERE_WE_REGENERATE_PROJECT}/.npm.scripts/project/*.sh



cd ${WHERE_WE_REGENERATE_PROJECT}/

# You install the dependencies
npm run gulp:project:dependencies:clean && npm run gulp:project:dependencies
# you just regenerate the whole project like this:
npm run gulp:project:scratch

# After that you can run the compiled Gulpfile :
npm run dev

`ESLint` `TypeScript` configuration

References

https://khalilstemmler.com/blogs/typescript/eslint-for-typescript/
https://dev.to/caelinsutch/setting-up-a-typescript-nodejs-application-with-prettier-and-eslint-53jc
About how complex it is to make a "pure ESM NodeJS TypeScript project" : https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c#faq
About the issue that happens when NodeJS + --module es2022 (or module is any ESM version) + TypeScript : https://docs.joshuatz.com/cheatsheets/node-and-npm/node-esm/#typescript---fully-resolved-import-filepaths-with-extensions
About the difference between --target and --module (so much the bottom question when starting a new typescript project...) :

@infinitebrahmanuniverse/nolb-_pok @everything-registry/sub-chunk-730

0.0.0-omega

3 years ago

0.0.0-alpha