ci(github): fix type exports in packages/cactus-common #3649
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ruzell22
requested review from
petermetz,
izuru0,
jagpreetsinghsasan,
VRamakrishna,
sandeepnRES and
outSH
as code owners
|
Before fix: After fix: EDIT: I made changes to index.js and index.d.ts, however, it is not being added by git add -A before committing and pushing the code. |
ruzell22
force-pushed
the
issue3635
branch
4 times, most recently
from
d2a08ad
to
ac4f10f
Compare
Primary Changes --------------- 1. Remove packages/cactus-common/hyperledger-cactus-common-*.tgz in ignore paths in get-all-tgz-path.ts file 2. Added the missing LogLevelDesc in index.ts as per attw -f json error log Fixes: hyperledger-cacti#3635 Signed-off-by: ruzell22 <[email protected]>
outSH
approved these changes
Nov 25, 2024
petermetz
requested changes
Nov 26, 2024
Comment on lines
+3
to
+17
| export const LogLevel = { | ||
| TRACE: "TRACE", | ||
| trace: "trace", | ||
| ERROR: "ERROR", | ||
| error: "error", | ||
| WARN: "WARN", | ||
| warn: "warn", | ||
| INFO: "INFO", | ||
| info: "info", | ||
| DEBUG: "DEBUG", | ||
| debug: "debug", | ||
| SILENT: "SILENT", | ||
| silent: "silent", | ||
| } as const; | ||
| export type LogLevelDesc = (typeof LogLevel)[keyof typeof LogLevel]; |
There was a problem hiding this comment.
- Please do not write code directly in index.ts, it is meant to collect the public API surface exports and that will very noisy if you start writing code directly in it.
- Could you make the LogLevelDesc type a match to what is defined in
packages/cactus-common/node_modules/loglevel/index.d.ts? There's nothing wrong by the looks of it with what you have here, but it is the safest if we use the exact same definition that the library uses internally to reduce the risk of type compatibility issues later on.
/**
* Log levels
*/
interface LogLevel {
TRACE: 0;
DEBUG: 1;
INFO: 2;
WARN: 3;
ERROR: 4;
SILENT: 5;
}
/**
* Possible log level numbers.
*/
type LogLevelNumbers = LogLevel[keyof LogLevel];
/**
* Possible log level descriptors, may be string, lower or upper case, or number.
*/
type LogLevelDesc = LogLevelNumbers
| 'trace'
| 'debug'
| 'info'
| 'warn'
| 'error'
| 'silent'
| keyof LogLevel;
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Commit to be reviewed
ci(github): fix type exports in packages/cactus-common
Fixes: #3635
Pull Request Requirements
upstream/mainbranch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.-sflag when usinggit commitcommand. You may refer to this link for more information.Character Limit
A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.