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.

Sign up for GitHub

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

Jump to bottom

refactor: normalize terminology and project structure #50

Merged
merged 81 commits into from
Dec 5, 2020
Merged

refactor: normalize terminology and project structure #50

merged 81 commits into from
Dec 5, 2020

Conversation

LayZeeDK
Copy link
Member

@LayZeeDK LayZeeDK commented Dec 2, 2020 •
edited
Loading

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our guidelines: CONTRIBUTING.md#commit
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[x] Code style update (formatting, local variables)
[x] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

  1. Terminology is a little confusing and sometimes inconsistent.
  2. Naming of files and folders is inconsistent.

Issue Number: N/A

What is the new behavior?

  1. Sticking to agreed terminology and public API export names.
  2. Files and folders use a similar structure throughout the codebase

Does this PR introduce a breaking change?

[x] Yes
[ ] No

A LOT of breaking changes before version 2.0.0.

Other information

Terminology and structure review

  • @ngworker/lumberjack
  • @ngworker/lumberjack/console-driver
  • @ngworker/lumberjack/http-driver
  • READMEs
  • @internal/test-util
  • @internal/test-util/console-driver

@LayZeeDK LayZeeDK changed the title Throw everything up in the air and see where it lands refactor: throw everything up in the air and see where it lands Dec 2, 2020
@LayZeeDK LayZeeDK changed the title refactor: throw everything up in the air and see where it lands refactor: normalize terminology and project structure Dec 3, 2020
@LayZeeDK LayZeeDK marked this pull request as ready for review December 3, 2020 22:47
@LayZeeDK
docs: delete auto-generated README
c6b239a
@LayZeeDK
feat: mark interface properties as readonly access
bbc6bbd 
BREAKING CHANGE:
Interfaces exposed in version 1 now have properties with readonly access.
@LayZeeDK
refactor: normalize configs structure
fddade4
@LayZeeDK
refactor: normalize log drivers structure
3a61a7d
@LayZeeDK
refactor: rename LumberjackLogLevel to LumberjackLevel
51ab6f0 
BREAKING CHANGE:
LumberjackLogLevel is renamed to LumberjackLevel.
@LayZeeDK
refactor: extract LumberjackLevel to separate file
d5c2ed5
@LayZeeDK
refactor: rename LumberjackLogEntryLevel to LumberjackLogLevel
0a16d8d 
BREAKING CHANGE:
LumberjackLogEntryLevel is renamed to LumberjackLogLevel.
@LayZeeDK
refactor: extract LumberjackLogLevel to separate file
fbe8925
@LayZeeDK
refactor: rename LumberjackLogConfigLevels to LumberjackConfigLevels
23fb65a 
BREAKING CHANGE:
LumberjackLogConfigLevels is renamed to LumberjackConfigLevels
@LayZeeDK
refactor: extract LumberjackConfigLevels into separate file
c148b1e
@LayZeeDK
refactor: explicitly export LumberjackLog
6347060
@LayZeeDK
refactor: move LumberjackLogger and LumberjackService
26cec91
@LayZeeDK
refactor: explicitly expose LumberjackTimeService
651fd1c
@LayZeeDK
refactor: move LumberjackModule, rename configuration folder
c28e388
@LayZeeDK
test: extract sut variables
e185417
@LayZeeDK
docs: organize public API
c7df130
@LayZeeDK
refactor: group console driver package into APIs
106bb1e
@LayZeeDK
refactor: group files into configuration API
44bb29b
@LayZeeDK
refactor: group files into log drivers API
82c6c1e
@LayZeeDK
refactor: rename log drivers API
8f17339
@LayZeeDK
refactor: group files into logs API
dbb359b
@LayZeeDK
refactor: rename HttpLog, rename HttpLog#formattedLog
0d37281 
BREAKING CHANGE:
- HttpLogEntry is renamed to HttpLog.
- HttpLog#log is renamed to formattedLog.
@LayZeeDK
refactor: move retryWithDelay operator
20ce2b0
@LayZeeDK
refactor: rename lumberjack.log.ts
cc54af0
@LayZeeDK
refactor: rename lumberjackLogDriverToken
488fd09
@LayZeeDK LayZeeDK force-pushed the LayZeeDK/refactor/structure-review branch from 2c57dc7 to a8c351b Compare December 3, 2020 23:02
NachoVazquez
NachoVazquez requested changes Dec 4, 2020
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
libs/internal/test-util/src/index.ts Show resolved Hide resolved
libs/internal/test-util/src/lib/error-throwing-driver/error-throwing-driver.config.ts Outdated Show resolved Hide resolved
libs/ngworker/lumberjack/http-driver/README.md Outdated Show resolved Hide resolved
libs/ngworker/lumberjack/http-driver/README.md Outdated Show resolved Hide resolved
libs/ngworker/lumberjack/http-driver/README.md Outdated Show resolved Hide resolved
@NachoVazquez NachoVazquez merged commit 6001525 into main Dec 5, 2020
@NachoVazquez NachoVazquez deleted the LayZeeDK/refactor/structure-review branch December 5, 2020 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NachoVazquez NachoVazquez NachoVazquez approved these changes

Assignees
No one assigned
Labels
None yet
Projects
Lumberjack
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@LayZeeDK @NachoVazquez