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

maintenance: rename Types / Interfaces / Enums #1594

Closed
bartekleon opened this issue Jun 20, 2019 · 5 comments
Closed

maintenance: rename Types / Interfaces / Enums #1594

bartekleon opened this issue Jun 20, 2019 · 5 comments

Comments

@bartekleon
Copy link
Member

Lurking through the code I can see that all types, interfaces, enums, are just ex 'strykerOptions'. It doesn't give a lot of info about what it is (especially in imports). Since we are using a lot of types, some may be the same in different packages (Range is already in Typescript).

My idea is to rename all of them, so it is easier to know, what exactly we are dealing with (without going to declaration etc.)

Types: starting with T - TRange
Interfaces: starting with I - IStrykerConfig
Enums: starting with E - ELogLevel

@nicojs
Copy link
Member

nicojs commented Jun 24, 2019

A kind of hungarian notation for naming types, interfaces and enums is not recommended for typescript. Using an I for interfaces is something that you do a lot in C#, but it is also not accepted in the larger typescript community.

I'm of the opinion that the code should speak for itself and be clear, no matter what the exact type of things is. Your code editor should help you to determine the exact types of things if you need it.

When we started with Stryker, there were no style guides. Now there are. I think we're mostly in line with this one: https://basarat.gitbooks.io/typescript/docs/styleguide/styleguide.html#interface

Maybe we should document this in the contributing.md? I'll be happy to accept a PR for it :)

@bartekleon
Copy link
Member Author

we should create our own personalized tslint config so everything will be documented there (we can take all available properties and set them accordingly to our needs) [i can prepare prepare PR for both tslint config and contributing.md)

@nicojs
Copy link
Member

nicojs commented Jul 1, 2019

That makes sense. But we first should try to look for ones that implement basarat's style guide (or ESlint plugins that do that).

@bartekleon
Copy link
Member Author

@nicojs I could lurk a bit. If it already exists I can extend it, if not, I can make one based on basarat's style guide and 'my personal preferences'

@bartekleon
Copy link
Member Author

@nicojs I have some problem with linting, since in your styleGuide there is 'use camelCase' and you are using in dozen of files 'PascalCase'. I'll leave it for now. You will decide what to do with that later

@nicojs nicojs closed this as completed Jul 4, 2019
sanderkoenders pushed a commit that referenced this issue Jul 12, 2019
….1 (#1538)

* build(deps-dev): update react-scripts requirement from ~2.1.0 to ~3.0.1

Updates the requirements on [react-scripts](https://github.com/facebook/create-react-app/tree/HEAD/packages/react-scripts) to permit the latest version.
- [Release notes](https://github.com/facebook/create-react-app/releases)
- [Changelog](https://github.com/facebook/create-react-app/blob/master/CHANGELOG.md)
- [Commits](https://github.com/facebook/create-react-app/commits/react-scripts@3.0.1/packages/react-scripts)

Signed-off-by: dependabot[bot] <support@dependabot.com>

* v2.0.0

* fix(inquirer): fix inquirer types (#1563)

* build(deps-dev): update webpack requirement from ~4.31.0 to ~4.32.2 (#1557)

Updates the requirements on [webpack](https://github.com/webpack/webpack) to permit the latest version.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](webpack/webpack@v4.31.0...v4.32.2)

Signed-off-by: dependabot[bot] <support@dependabot.com>

* build(deps): update log4js requirement from ~4.2.0 to ~4.3.0 (#1556)

Updates the requirements on [log4js](https://github.com/log4js-node/log4js-node) to permit the latest version.
- [Release notes](https://github.com/log4js-node/log4js-node/releases)
- [Changelog](https://github.com/log4js-node/log4js-node/blob/master/CHANGELOG.md)
- [Commits](log4js-node/log4js-node@v4.2.0...v4.3.0)

Signed-off-by: dependabot[bot] <support@dependabot.com>

* build(deps): update semver requirement from ~6.0.0 to ~6.1.0 (#1555)

Updates the requirements on [semver](https://github.com/npm/node-semver) to permit the latest version.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/master/CHANGELOG.md)
- [Commits](npm/node-semver@v6.0.0...v6.1.0)

Signed-off-by: dependabot[bot] <support@dependabot.com>

* build(deps): update istanbul-lib-instrument requirement (#1532)

Updates the requirements on [istanbul-lib-instrument](https://github.com/istanbuljs/istanbuljs) to permit the latest version.
- [Release notes](https://github.com/istanbuljs/istanbuljs/releases)
- [Commits](https://github.com/istanbuljs/istanbuljs/compare/istanbul-lib-instrument@3.2.0...istanbul-lib-instrument@3.3.0)

Signed-off-by: dependabot[bot] <support@dependabot.com>

* build(ts): fix lint and pin ts version (#1577)

* build(deps-dev): update raw-loader requirement from ~2.0.0 to ~3.0.0 (#1576)

Updates the requirements on [raw-loader](https://github.com/webpack-contrib/raw-loader) to permit the latest version.
- [Release notes](https://github.com/webpack-contrib/raw-loader/releases)
- [Changelog](https://github.com/webpack-contrib/raw-loader/blob/master/CHANGELOG.md)
- [Commits](webpack-contrib/raw-loader@v2.0.0...v3.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps): update tslib requirement from ~1.9.3 to ~1.10.0 (#1582)

Updates the requirements on [tslib](https://github.com/Microsoft/tslib) to permit the latest version.
- [Release notes](https://github.com/Microsoft/tslib/releases)
- [Commits](microsoft/tslib@1.9.3...1.10.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps): update typed-rest-client requirement from ~1.4.0 to ~1.5.0 (#1580)

Updates the requirements on [typed-rest-client](https://github.com/Microsoft/typed-rest-client) to permit the latest version.
- [Release notes](https://github.com/Microsoft/typed-rest-client/releases)
- [Commits](https://github.com/Microsoft/typed-rest-client/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps-dev): update webpack requirement from ~4.32.2 to ~4.34.0 (#1584)

Updates the requirements on [webpack](https://github.com/webpack/webpack) to permit the latest version.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](webpack/webpack@v4.32.2...v4.34.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps-dev): update tslint requirement from ~5.16.0 to ~5.17.0 (#1570)

Updates the requirements on [tslint](https://github.com/palantir/tslint) to permit the latest version.
- [Release notes](https://github.com/palantir/tslint/releases)
- [Changelog](https://github.com/palantir/tslint/blob/master/CHANGELOG.md)
- [Commits](palantir/tslint@5.16.0...5.17.0)

* fix(html): set utf-8 charset (#1592)

* refactor(file names): align on file names (#1605)

* build(ci): disable execa timeout to prevent failing perf job (#1604)

* v2.0.1

* refactor(tslint): match basarat styleGuide (#1594) (#1615)

* build(deps-dev): update tslint requirement from ~5.17.0 to ~5.18.0 (#1598)

Updates the requirements on [tslint](https://github.com/palantir/tslint) to permit the latest version.
- [Release notes](https://github.com/palantir/tslint/releases)
- [Changelog](https://github.com/palantir/tslint/blob/master/CHANGELOG.md)
- [Commits](palantir/tslint@5.17.0...5.18.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps): update inquirer requirement from ~6.3.1 to ~6.4.1 (#1599)

Updates the requirements on [inquirer](https://github.com/SBoudrias/Inquirer.js) to permit the latest version.
- [Release notes](https://github.com/SBoudrias/Inquirer.js/releases)
- [Commits](https://github.com/SBoudrias/Inquirer.js/compare/inquirer@6.3.1...inquirer@6.4.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps): update log4js requirement from ~4.3.0 to ~4.4.0 (#1602)

Updates the requirements on [log4js](https://github.com/log4js-node/log4js-node) to permit the latest version.
- [Release notes](https://github.com/log4js-node/log4js-node/releases)
- [Changelog](https://github.com/log4js-node/log4js-node/blob/master/CHANGELOG.md)
- [Commits](log4js-node/log4js-node@v4.3.0...v4.4.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps): update semver requirement from ~6.1.0 to ~6.2.0 (#1616)

Updates the requirements on [semver](https://github.com/npm/node-semver) to permit the latest version.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/master/CHANGELOG.md)
- [Commits](npm/node-semver@v6.1.0...v6.2.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps-dev): update webpack requirement from ~4.34.0 to ~4.35.3 (#1627)

Updates the requirements on [webpack](https://github.com/webpack/webpack) to permit the latest version.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](webpack/webpack@v4.34.0...v4.35.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* fix(dispose): fix raise condition in dispose action

Fix a raise condition during disposing of our resources. Now using [typed-inject's dispose functionality](https://github.com/nicojs/typed-inject/#-disposing-provided-stuff)

Fixes #1542

* fix(child process proxy): OutOfMemory detection (#1635)

Make sure out `OutOfMemory` detection works as expected. This fixes a race condition in which the detection didn't work correctly, and an unexpected error was assumed. See #1634

* fix(child process): cleanup after dispose (#1636)

* v2.0.2

* docs(changelog): fix typo raise -> race

* build(deps-dev): update @babel/preset-env requirement (#1637)

Updates the requirements on [@babel/preset-env](https://github.com/babel/babel) to permit the latest version.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md)
- [Commits](babel/babel@v7.4.1...v7.5.4)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps): update @babel/generator requirement from ~7.4.0 to ~7.5.0 (#1631)

Updates the requirements on [@babel/generator](https://github.com/babel/babel) to permit the latest version.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md)
- [Commits](babel/babel@v7.4.0...v7.5.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps-dev): update @babel/core requirement from ~7.4.0 to ~7.5.4 (#1629)

Updates the requirements on [@babel/core](https://github.com/babel/babel) to permit the latest version.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md)
- [Commits](babel/babel@v7.4.0...v7.5.4)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps-dev): update @babel/types requirement from ~7.4.0 to ~7.5.0 (#1632)

Updates the requirements on [@babel/types](https://github.com/babel/babel) to permit the latest version.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md)
- [Commits](babel/babel@v7.4.0...v7.5.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps-dev): update @types/express requirement (#1571)

Updates the requirements on [@types/express](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/express) to permit the latest version.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/express)

* build(deps): update @babel/traverse requirement from ~7.4.0 to ~7.5.0 (#1633)

Updates the requirements on [@babel/traverse](https://github.com/babel/babel) to permit the latest version.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md)
- [Commits](babel/babel@v7.4.0...v7.5.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps-dev): update @babel/cli requirement from ~7.4.3 to ~7.5.0 (#1630)

Updates the requirements on [@babel/cli](https://github.com/babel/babel) to permit the latest version.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md)
- [Commits](babel/babel@v7.4.3...v7.5.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* chore(issue templates): add issue templates 

Add issue templates for feature, bug and question

* build(deps-dev): update execa requirement from ^1.0.0 to ^2.0.3 (#1625)

Updates the requirements on [execa](https://github.com/sindresorhus/execa) to permit the latest version.
- [Release notes](https://github.com/sindresorhus/execa/releases)
- [Commits](sindresorhus/execa@v1.0.0...v2.0.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* build(deps-dev): update react-scripts requirement from ~2.1.0 to ~3.0.1

Updates the requirements on [react-scripts](https://github.com/facebook/create-react-app/tree/HEAD/packages/react-scripts) to permit the latest version.
- [Release notes](https://github.com/facebook/create-react-app/releases)
- [Changelog](https://github.com/facebook/create-react-app/blob/master/CHANGELOG.md)
- [Commits](https://github.com/facebook/create-react-app/commits/react-scripts@3.0.1/packages/react-scripts)

Signed-off-by: dependabot[bot] <support@dependabot.com>

* Fix(Jest): Alter expected Jest config to match current
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

No branches or pull requests

2 participants