intuit / ld-react-components Goto Github PK

This is one part of a set of issues for refactoring to TypeScript.

Refactor FeatureFlag component to TypeScript (src/lib/FeatureFlag).

[ ] Passes linting
[ ] Unit Tests Pass

This is one part of a set of issues for refactoring to TypeScript.

Refactor FeatureFalse component to TypeScript (src/lib/FeatureFalse).

[ ] Passes linting
[ ] Unit Tests Pass

Update all current dependencies and run tests and ensure tests are still passing.

Describe the bug

Currently when merging/releasing a new version, CircleCi successfully builds the main portion of the project however it fails to force push to the orphaned gh-branch for publishing the demo/docs.

To Reproduce

Create a PR, merge PR then look at the CircleCi builds. Alternatively, can visit the following link to see failing builds in CircleCi - https://circleci.com/gh/intuit/LD-React-Components

Expected behavior

Releases will successfully push to the gh-pages branch and report back a passing build to Github.

Describe the bug
The client has jsdoc comments but not proper ts types
https://github.com/intuit/LD-React-Components/blob/master/src/lib/LaunchDarklyClient/index.ts

Describe the bug

There are some notable security issues found in the dependency tree. Please review and resolve them.

Screenshots

This is one part of a set of issues for refactoring to TypeScript.

Refactor FeatureTrue component to TypeScript (src/lib/FeatureTrue).

[ ] Passes linting
[ ] Unit Tests Pass

Is your feature request related to a problem? Please describe.
Since we have multiple contributors , its essential to maintain commit hygiene and ensure that commit message conventions are followed

Describe the solution you'd like

Setup Commitlint and configure a husky pre-commit hook to ensure that all commit messages are checked.

Describe alternatives you've considered

Commitlint paired with husky is the most recommended setup

Additional context

Describe the bug

Currently this repo utilized all-contributors-cli for adding contributors to the readme. At this time it would appear the generator is not working correctly.

To Reproduce

1. Clone package and run yarn to install dependencies.
2. Run yarn contributors:add to start the process of adding a contributor.
3. Select any option and it should encounter an error.

Expected behavior

Able to get thru whole process and contributors are automatically added to the correct place in the readme file.

Is your feature request related to a problem? Please describe.

Currently contributors must manually add themselves as contributors via CLI. Ideally this would be a step that can be skipped if the all-contributors-bot were implemented.

Describe the solution you'd like

Implement the all-contributors-bot so that contributors are automatically added to the readme and the all contributors badge count number is updated to correctly reflected.

This is one part of a set of issues for refactoring to TypeScript.

Refactor FeatureCase component to TypeScript (src/lib/FeatureCase).

[ ] Passes linting
[ ] Unit Tests Pass

This repo is coming along nicely in terms of quality control but it can always improve. Perhaps adding some linting will help further improve it. Ideally this repo would be setup using the configuration from https://github.com/paulolramos/eslint-prettier-airbnb-react.

Then of course without modifying a bunch of rules go thru and fix the issues found. Once issues are found we can then add the prettier badge to the readme and feel good about it.

I have a theory. While builds are succeeding and the gh-page's branch is now being correctly skipped. It's old status of failed on the gh-pages branch is being syndicated since it reports the last known status for skipped branches. Just a theory.

The goal is to once again have a passing status come from CircleCi. It may even require contacting and working with them to fix.

There's a lot of benefit to using TypeScript for collaboration but also for self documenting code. Would be nice to have this project follow suit.

This issue is for setting up the scaffolding to support incremental TS building.

[ ] Backwards compatible
[ ] Tests Pass
[ ] Linting Passes

Describe the bug

One of the recent feature enhancements for converting the package to a TypeScript has broken the Storybook documentation.

To Reproduce

See gh-pages:
https://intuit.github.io/LD-React-Components/?path=/story/component-feature-flag--basic-feature-flag

Expected behavior

No errors should appear and the component should show.

Based on CircleCi's documentation add Test Summaries. See documentation here: https://circleci.com/docs/2.0/configuration-reference/#store_test_results

Describe the bug

When a large majority of file extensions were changed from .js the references were not changed accordingly.

Example:

I believe this is also affecting import references that assume .js and not .ts extensions such as import FeatureCase from '../FeatureCase';.

Also package.json references index.js that doesn't exist.

This is one part of a set of issues for refactoring to TypeScript.

Refactor LaunchDarklyClient component to TypeScript (src/lib/LaunchDarklyClient).

[ ] Passes linting
[ ] Unit Tests Pass

The current demo/gh-pages documentation is an unstyled plain text page. It would be nice to make this more attractive. You can see what it looks like today here: https://intuit.github.io/LD-React-Components/

It would appear since the change over to TypeScript. The js files in dist are no longer found when compiling inside applications. Please see code block below.

ERROR in ../node_modules/ld-react-components/API/index.js
Module not found: Error: Can't resolve '../dist/LaunchDarklyClient/index.js' in '/Users/dbergschneider/site/node_modules/ld-react-components/API'

ERROR in ../node_modules/ld-react-components/dist/index.js
Module not found: Error: Can't resolve './FeatureCase' in '/Users/dbergschneider/site/node_modules/ld-react-components/dist'

ERROR in ../node_modules/ld-react-components/dist/index.js
Module not found: Error: Can't resolve './FeatureDefault' in '/Users/dbergschneider/site/node_modules/ld-react-components/dist'

ERROR in ../node_modules/ld-react-components/dist/index.js
Module not found: Error: Can't resolve './FeatureFalse' in '/Users/dbergschneider/site/node_modules/ld-react-components/dist'

ERROR in ../node_modules/ld-react-components/dist/index.js
Module not found: Error: Can't resolve './FeatureSwitch' in '/Users/dbergschneider/site/node_modules/ld-react-components/dist'

ERROR in ../node_modules/ld-react-components/dist/index.js
Module not found: Error: Can't resolve './FeatureTrue' in '/Users/dbergschneider/site/node_modules/ld-react-components/dist'

ERROR in ../node_modules/ld-react-components/dist/index.js
Module not found: Error: Can't resolve './LaunchDarklyClient' in '/Users/dbergschneider/site/node_modules/ld-react-components/dist'

Is your feature request related to a problem? Please describe.

Some of the dependencies are out of date and it is crucial for the maintenance of this package to keep up with React and TypeScript. This may mean updating code for compatibility with newer standards.

An easy way to do this is to setup npm-check-updates via yarn global add npm-check-updates.
This will provide a list of all dependencies needing to be updated and wether they are major breaking changes or not.

Example in screenshot below:

This is one part of a set of issues for refactoring to TypeScript.

Refactor FeatureDefault component to TypeScript (src/lib/FeatureDefault).

[ ] Passes linting
[ ] Unit Tests Pass

Issue #18 replaced the demo/docs with Storybook. However only the first component was added to the new format. Utilizing the old docs which can be found in the link below add the remaining examples to storybook.

old docs: https://intuit.github.io/LD-React-Components/old-docs/

Bonus if you can figure out a means to default storybook to the docs view instead of canvas view.

This is one part of a set of issues for refactoring to TypeScript.

Refactor FeatureSwitch component to TypeScript (src/lib/FeatureSwitch).

[ ] Passes linting
[ ] Unit Tests Pass