jasminabasurita / react-line-overflow Goto Github PK

https://docs.npmjs.com/misc/developers#keeping-files-out-of-your-package

Examples:

• https://github.com/evilsoft/crocks/blob/master/.npmignore
• https://github.com/rpearce/react-medium-image-zoom/blob/master/.npmignore

When a user passes a non-hex value to background or passes a non-string type to ellipsis a type error should be thrown

IMO, ramda at XYZ version is a hefty dependency to add to a library. I would recommend creating your own helper functions that encapsulate this functionality.

If that's not reasonable, I recommend either including the packages individually or making use of https://www.npmjs.com/package/babel-plugin-transform-imports in order to not include all of ramda here.

But option #1 (own helper functions) is still the recommended one here.

The component should:

• recalculate css on component update
• should only update when it's contents change in a way that effect the length of the size/length of the text (i.e. className/style or text changes

I've learned the hard way that this should be done from the start.

• jest
• enzyme
• enzyme-adapter-react-16
• enzyme-to-json
• eslint-plugin-jest
• NPM scripts:

  "test": "jest",
  "coverage": "yarn run test -- --coverage --no-cache",

• with coverage make sure to collect coverage from where it's desired:

  "jest": {
    "collectCoverageFrom": [
      "<rootDir>/src/**/*.{js,jsx}"
    ],
  }

A user should be able to pass a flag to have the component refactor on window resize

Consider using $ yarn version when making updates.

https://yarnpkg.com/lang/en/docs/cli/version/

The Flow:

1. merge code into master
2. $ git checkout master && git pull
3. $ yarn version (follow instructions)
4. $ git push origin master
5. $ npm publish

You can set the project to have a github page and have it read from the docs/ folder (check out project settings). Example: https://github.com/rpearce/react-medium-image-zoom/tree/master/docs and then the outputted page is at https://rpearce.github.io/react-medium-image-zoom/

No need to commit the build to github – this is "compiled" code output that probably doesn't need to live here

https://github.com/jasminabasurita/react-line-overflow/blob/master/src/index.js#L62

• add an AUTHORS file (https://docs.npmjs.com/files/package.json#default-values; example: https://github.com/rpearce/react-medium-image-zoom/blob/master/AUTHORS)
• add a CHANGELOG.md and update from the very start
• link to an API.md file (or equivalent) from the README.md where you describe usage
• use GitHub's project tools to add a CODE_OF_CONDUCT.md to the package
• set up eslint
  • http://npmjs.com/package/eslint
  • https://www.npmjs.com/package/eslint-plugin-react
  • https://www.npmjs.com/package/eslint-plugin-jsx-a11y
  • https://www.npmjs.com/package/eslint-plugin-jest (for tests)
• consider setting up an "All Contributors" section (https://github.com/kentcdodds/all-contributors; example: https://github.com/rpearce/react-medium-image-zoom#contributors)
• Add CONTRIBUTING.md file that specifies everything to know about contributing and link to this from README

postcss-easing-gradients is unused.

https://www.npmjs.com/package/react-line-overflow

Current Behavior:

if text takes up less than what would be considered overflow in height the containing box still takes up the full height

Expected Behavior:

When lines are less than the max num lines the component should only take up as much space as the text

Probably just needs to be switched from height to max-height