telus / create-library Goto Github PK

View Code? Open in Web Editor NEW

6.0 6.0 7.0 1.19 MB

An opinionated npm package starter kit

License: MIT License

JavaScript 97.65% Shell 2.35%

create init initializer npm platform security-kpi telus-digital

create-library's People

Contributors

Stargazers

Watchers

Forkers

billxinli alfredctchoi ruxandrafed anoopsinha97 shubhamtyagi02 sunniya12 fareedkhan-dev

create-library's Issues

Update FAQ with something re. how lint:deps works (focus on private deps scenario)

Update NPM token to github machine user

Using @ahmadnassri's token at the moment, so he gets to boast about his intensive Github activity LOL.

Library naming conventions missing

Add a note in the readme to make consumers aware of the fact that they should name the library wisely (consider scope, consider overlap with other existing/future libraries, etc.)

Better docs, link to guides, clarify version in `package.json`

[CRITICAL] Public Repository Created

Please note that this repository is publicly visible to the internet!

/cc @ahmadnassri
/cc @admins

Missing discovery tool for all existing TELUS libraries

Until we figure out the matter of NPM access provisioning, how can existing team members get visibility into already existing libraries before creating similar/duplicate ones?

Cannot find module '@telus/eslint-config' and remark

Checking out the latest master branch, we are seeing the following issues:

Cannot find module '@telus/eslint-config'
and
command not found: remark

Bills-MacBook-Pro:create-library billli$ npm run lint

> @telus/[email protected] lint /Users/billli/Code/telus/create-library
> npx npm-run-all -p -c -l lint:*

npx: installed 58 in 3.558s
[lint:deps ]
[lint:deps ] > @telus/[email protected] lint:deps /Users/billli/Code/telus/create-library
[lint:deps ] > npx updated
[lint:deps ]
[lint:audit]
[lint:audit] > @telus/[email protected] lint:audit /Users/billli/Code/telus/create-library
[lint:audit] > npm audit
[lint:audit]
[lint:js   ]
[lint:js   ] > @telus/[email protected] lint:js /Users/billli/Code/telus/create-library
[lint:js   ] > npx eslint .
[lint:js   ]
[lint:md   ]
[lint:md   ] > @telus/[email protected] lint:md /Users/billli/Code/telus/create-library
[lint:md   ] > npx remark --quiet --frail .
[lint:md   ]
[lint:ec   ]
[lint:ec   ] > @telus/[email protected] lint:ec /Users/billli/Code/telus/create-library
[lint:ec   ] > npx editorconfig-checker .
[lint:ec   ]
[lint:js   ] Cannot find module '@telus/eslint-config'
[lint:js   ] Referenced from: /Users/billli/Code/telus/create-library/.eslintrc
[lint:js   ] npm ERR! code ELIFECYCLE
[lint:js   ] npm ERR! errno 1
[lint:js   ] npm ERR! @telus/[email protected] lint:js: `npx eslint .`
[lint:js   ] npm ERR! Exit status 1
[lint:js   ] npm ERR!
[lint:js   ] npm ERR! Failed at the @telus/[email protected] lint:js script.
[lint:js   ] npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
[lint:js   ] npm WARN Local package.json exists, but node_modules missing, did you mean to install?
[lint:js   ]
[lint:js   ] npm ERR! A complete log of this run can be found in:
[lint:js   ] npm ERR!     /Users/billli/.npm/_logs/2019-01-08T02_26_17_683Z-debug.log
[lint:audit] === npm audit security report ===
[lint:audit]
[lint:audit] found 0 vulnerabilities
[lint:audit]  in 1014 scanned packages
[lint:deps ] npx: installed 1 in 1.81s
[lint:deps ] OUTDATED  	 ^2.2.4 → 2.2.6 	 fast-glob @ ^2.2.4
[lint:deps ] npm ERR! code ELIFECYCLE
[lint:deps ] npm ERR! errno 1
[lint:deps ] npm ERR! @telus/[email protected] lint:deps: `npx updated`
[lint:deps ] npm ERR! Exit status 1
[lint:deps ] npm ERR!
[lint:deps ] npm ERR! Failed at the @telus/[email protected] lint:deps script.
[lint:deps ] npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
[lint:deps ] npm WARN Local package.json exists, but node_modules missing, did you mean to install?
[lint:deps ]
[lint:deps ] npm ERR! A complete log of this run can be found in:
[lint:deps ] npm ERR!     /Users/billli/.npm/_logs/2019-01-08T02_26_19_836Z-debug.log
[lint:md   ] npx: installed 49 in 3.253s
[lint:md   ] command not found: remark
[lint:md   ] npm ERR! code ELIFECYCLE
[lint:md   ] npm ERR! errno 1
[lint:md   ] npm ERR! @telus/[email protected] lint:md: `npx remark --quiet --frail .`
[lint:md   ] npm ERR! Exit status 1
[lint:md   ] npm ERR!
[lint:md   ] npm ERR! Failed at the @telus/[email protected] lint:md script.
[lint:md   ] npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
[lint:md   ] npm WARN Local package.json exists, but node_modules missing, did you mean to install?
[lint:md   ]
[lint:md   ] npm ERR! A complete log of this run can be found in:
[lint:md   ] npm ERR!     /Users/billli/.npm/_logs/2019-01-08T02_26_20_425Z-debug.log
[lint:ec   ] npx: installed 127 in 5.447s
[lint:ec   ] sucessfully checked 34 files :)
ERROR: "lint:md" exited with 1.
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! @telus/[email protected] lint: `npx npm-run-all -p -c -l lint:*`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the @telus/[email protected] lint script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
npm WARN Local package.json exists, but node_modules missing, did you mean to install?

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/billli/.npm/_logs/2019-01-08T02_26_22_947Z-debug.log
Bills-MacBook-Pro:create-library billli$

Running with:

Bills-MacBook-Pro:create-library billli$ node -v
v8.12.0
Bills-MacBook-Pro:create-library billli$ npm -v
6.4.1

.gitignore not being scaffolded

See https://github.com/telus/telus-core/blob/master/src/scaffold.js#L51 for inspiration/fix

NPM token for local development

Should the template include a script (like our init.sh scripts in the older SKs) that gets the NPM token from somewhere (vault?). It's not uncommon for our private libraries to have other private libraries as dependencies ..

It's easy for me to just copy that very same script and put it in there, but I'm not sure that's the approach we want to take. Maybe we should just add something to the README to tell people what to expect, but handle it differently? Are we gonna get npm enterprise and then ensure we have a solid onboarding process?

Thoughts, @ahmadnassri & @kspaans?

Add a step in the CLI to install peer dependencies

install-group peer --package @telus/build-essential --no-save

@telus/create-library package published on npmjs is broken due to missing dependency

I'm not able to leverage this initializer as the docs describe:

$ npm init @telus/library my-new-project
npm ERR! code E404
npm ERR! 404 Not Found - GET https://registry.npmjs.org/@telus%2fcore - Not found
npm ERR! 404
npm ERR! 404  '@telus/core@^0.0.3' is not in the npm registry.
npm ERR! 404 You should bug the author to publish it (or use the name yourself!)
npm ERR! 404 It was specified as a dependency of '@telus/create-library'
npm ERR! 404
npm ERR! 404 Note that you can also install from a
npm ERR! 404 tarball, folder, http url, or git url.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/phildufault/.npm/_logs/2019-12-30T18_59_33_802Z-debug.log
Install for @telus/create-library@latest failed with code 1

I'm following https://github.com/telus/create-library#-usage

The npm package published seems stale, as in the Git repo @telus/core is not referenced.

This might be a quick win, to publish a new release of this package to npmjs.org

I was able to clone this package's repo and use it locally to initialize a new npm library repo, so I believe just a new release to npmjs.org is needed.

Cheers! ❤️

Status badges for private packages

We should update the CLI to get token(s) needed for npm & build status badges in the case of private packages.

No check for @telus in package name

npm init for create-library not working due to dependency module format

got a report of npm init library not working:
https://telusdigital.slack.com/archives/C03LJ6SJR5F/p1688491751414059
was able to reproduce this error locally:

L600799:Code t967649$ mkdir test1
L600799:Code t967649$ cd test1
L600799:test1 t967649$ npm init @telus/library
Need to install the following packages:
  @telus/[email protected]
Ok to proceed? (y) y
/Users/t967649/.npm/_npx/730020322dede8e1/node_modules/@telus/create-library/lib/questions.js:1
const inquirer = require('inquirer')
                 ^

Error [ERR_REQUIRE_ESM]: require() of ES Module /Users/t967649/.npm/_npx/730020322dede8e1/node_modules/inquirer/lib/inquirer.js from /Users/t967649/.npm/_npx/730020322dede8e1/node_modules/@telus/create-library/lib/questions.js not supported.
Instead change the require of inquirer.js in /Users/t967649/.npm/_npx/730020322dede8e1/node_modules/@telus/create-library/lib/questions.js to a dynamic import() which is available in all CommonJS modules.
    at Object.<anonymous> (/Users/t967649/.npm/_npx/730020322dede8e1/node_modules/@telus/create-library/lib/questions.js:1:18)
    at Object.<anonymous> (/Users/t967649/.npm/_npx/730020322dede8e1/node_modules/@telus/create-library/lib/template.js:7:19)
    at Object.<anonymous> (/Users/t967649/.npm/_npx/730020322dede8e1/node_modules/@telus/create-library/index.js:7:18) {
  code: 'ERR_REQUIRE_ESM'
}

Node.js v18.16.0
npm ERR! code 1
npm ERR! path /Users/t967649/Code/test1
npm ERR! command failed
npm ERR! command sh -c create-library

npm ERR! A complete log of this run can be found in: /Users/t967649/.npm/_logs/2023-07-04T21_31_52_586Z-debug-0.log
L600799:test1 t967649$

it appears when the dependencies were last updated, the module format for inquirer was changed between v8 and v9
it appears to work if we roll this dep back:

L600799:create-library t967649$ git diff package.json | grep inquire
-    "inquirer": "^9.2.6",
+    "inquirer": "^8.2.3",
L600799:create-library t967649$ cd -
/Users/t967649/Code/test1
L600799:test1 t967649$ npm init @telus/[email protected]
npx: installed 82 in 8.696s
? is this an open source project? No
? project title blah

The automated release is failing 🚨

🚨 The automated release from the `main` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

Remove `isnodesafe`

It's only doing offline check at the moment (not live results). Until it will be updated/fixed, it can be removed.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions

.github/workflows/build.yaml

actions/checkout v2

actions/setup-node v2

.github/workflows/main.yaml

actions/checkout v2

actions/setup-node v2

actions/setup-python v2

google-github-actions/setup-gcloud v0.2.1

actions/checkout v2

.github/workflows/publish.yaml

actions/checkout v2

actions/setup-node v2

npm

package.json

fast-glob ^3.2.12

inquirer ^8.2.3

mkdirp ^1.0.4

spdx-license-list ^6.6.0

validate-npm-package-name ^3.0.0

yargs ^17.6.2

@commitlint/cli ^17.3.0

@commitlint/config-angular ^17.3.0

@telus/prettier-config ^3.2.4

@telus/remark-config ^2.2.5

@telus/semantic-release-config ^2.2.5

editorconfig-checker ^4.0.2

husky ^4.3.8

npm-run-all ^4.1.5

node >=14

Check this box to trigger a request for Renovate to run again on this repository

incorrect variable name in build-publish.yml

line 16 in build-publish.yml

NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

should it be NPM_AUTH_TOKEN instead of NPM_TOKEN?

Editor config should only check lib folder

Right now, it fails when the project has a coverage folder (with xml and iml files) or when using Jetbrains IDEs.

Have lint checks run on every commit

Using husky or something equivalent, have the lint scripts be run before each commit, so that developers receive instant feedback from eslint.

Pre-release version of a package

Issue
We have the following environments setup in Home Solutions:

Test
Staging
Production

We typically use the test environment as an integration environment so that we can test changes from multiple teams. In those cases when we want to test a component change, we do not want to publish it as a proper version, but instead do a pre-release.

Solution
The semantic-release team has a pre-release feature in beta right now. We should start using it once it's out of beta.

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.