vue-storefront icon indicating copy to clipboard operation
vue-storefront copied to clipboard

Refactor build process & ESLINT to be more developer friendly [Feature]:

Open jaydubb12 opened this issue 3 years ago • 0 comments
trafficstars

How the project can be improved?

  • Provide developer a means to utilize configurations via rollup to better triage build issues

  • Provide developers and product owners a means to establish a min gate for typescript coverage as part of build process

  • Provide developers a progress bar / output as part of build process

  • Provide a resource to support insights with respect to build issues related to circular dependencies and / or other dependency issues

  • Provide a configuration within Rollup to allow for improved triage of Typescript build

  • Deprecate use of peerDependencies, in package.json given yarn build process does NOT automatically take these dependencies into account

  • Extend the current rollup process to utilize the Babel, and nodePolyfill rollup plugins to provide a more robust / effective compilation of code

  • Extend / improve coverage of Typescript, Import and Vue plugins to improve the IDE static analysis and import resolution capabilities

What are the acceptance criteria?

  • As a developer I can utilize rollup configurations to better view / triage issues with build process

Screen Shot 2022-01-11 at 9 04 25 AM

  • As a developer I can see user friendly error / warning messages outputted in the console to help with debugging

Screen Shot 2022-01-11 at 9 05 11 AM

  • As a developer I can set / view type coverage thresholds and view a type coverage report at the time of compilation

Screen Shot 2022-01-11 at 9 05 58 AM

  • As a developer I can build the OOTB project utilizing yarn package manager, and not run into missing dependency issues

  • As a developer I can utilize Babel and nodePolyfills to help with the code compilation and output of more reliable code

  • As a developer I will have see fewer import errors / warnings when I view the code in my IDE

  • As a developer I can take advantage of the eslint platform and plugins to perform typescript specific code analysis, type checks, and leverage the "fix" feature to apply quick fixes to type imports, as well as inline code

Screen Shot 2022-01-11 at 9 10 12 AM

Additional information

The primary changes to realize this set of improvements would be

  • rollup build / compilation
  • ESLINT

What version of Vue Storefront this feature can be implemented?

2.5.x

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

jaydubb12 avatar Jan 10 '22 17:01 jaydubb12