[WIP] Generate README.md automagically #622

azerella · 2019-02-12T05:23:50Z

🚧 Work in progress ! 🚧

This branch is based off of feature/hoist-node-modules-to-root. It features a script that will automatically generate the contents of the README.md for each component in the components/ folder.

UPDATE: 20/02/2019

Added prop jsdoc descriptions for each singular component.
Added missing defaultProp types for isRequired properties.

In automating the README.md I've found that certain components have multiple definitions inside. Automatically extracting these is very difficult and we will need to do a large refactor in order to resolve this. One suggestion might be to split up the sub-components into separate files.

Example:

- `callout` also contains a `calendar` component...
- `header` also contains a `headerBrand` component...
- `footer` also contains a `footerEnd` and `footerNav` component...

Another suggestion could be to publish these components separately.

Full-list of components to decouple:

- callout
- control-input
- footer
- header
- inpage-nav
- keyword-list
- main-nav
- progress-indicator
- select
- skip-link

* First steps with yarn workspaces * Switched sass imports to read from src Setup yarn workspaces First attempt at modifying helper.js * Removed pancake folder * Upgraded babel and webpack * Updated circleci image and build process * Upgraded webpack ES6 for babel-loader Upgraded ES6 helper babel process * Commented out devDep checks, need to rewrite * Added node-module caching to circleci * Put restore_cache key in wrong order :'( * Removed pancake root key Gave module versions some love Updated circleci comments * Package formatting * Installed mocha/chai over jest, removed jest * Updated 50% of unit tests * Renamed packages -> components * Installed babel preset minify * added preset to .babelrc * updated README.md * Trailing process.exit for circleci * Updated autoprefixer tag to be inline with spec Trialing node direct script over yarn * Added mode flag to webpack config - creates warning in webpack 4 * Playing around with puppetter args and circle images * Removed debug flags, trying node image * Updated circleci image * Helper should read from src for file check and build to lib/ * Correct webpack config to reference babel-preset-minify as a plugin not preset * Removed all instances of babel-preset-minify * Various tweaks based on PR review * Added back missing spacing * Added back es5 name convention * Webpack formatting * Forgot es5 name convention * Dependency shuffling * Added back ES6 dep comment * Trailing why git thinks _deps is new * Updated webpack output location Reverted helper react.es5.js changes back Added gitignore for react/tests/dist Updated ES6 dependency imports to pancake root folder * Added nuke script for pancake/ * Temporary resolved yarn workspace building by pretending animate requires sass * Added missing sass: name false key to animate * Reverted pretending animate hass sass * Resolved root and core vulnerabilities * Added missing whitespace in core * Updated engines, removed verbose --pancake from animate * Added back webpack ./bundle.js -> bundle.js * Updated local install instructions for yarn and grammar * Updated FAQ notes for yarn * Updated auds.json from latest develop * Upgraded circle node images to latest lts

Added desc to accordion.js props for testing

Removed unused deps Made code neater

Added comments and minor refactoring Updated links, markdown formatting

Updated type checks

* First steps with yarn workspaces * Switched sass imports to read from src Setup yarn workspaces First attempt at modifying helper.js * Removed pancake folder * Upgraded babel and webpack * Updated circleci image and build process * Upgraded webpack ES6 for babel-loader Upgraded ES6 helper babel process * Commented out devDep checks, need to rewrite * Added node-module caching to circleci * Put restore_cache key in wrong order :'( * Removed pancake root key Gave module versions some love Updated circleci comments * Package formatting * Installed mocha/chai over jest, removed jest * Updated 50% of unit tests * Renamed packages -> components * Installed babel preset minify * added preset to .babelrc * updated README.md * Trailing process.exit for circleci * Updated autoprefixer tag to be inline with spec Trialing node direct script over yarn * Added mode flag to webpack config - creates warning in webpack 4 * Playing around with puppetter args and circle images * Removed debug flags, trying node image * Updated circleci image * Helper should read from src for file check and build to lib/ * Correct webpack config to reference babel-preset-minify as a plugin not preset * Removed all instances of babel-preset-minify * Various tweaks based on PR review * Added back missing spacing * Added back es5 name convention * Webpack formatting * Forgot es5 name convention * Dependency shuffling * Added back ES6 dep comment * Trailing why git thinks _deps is new * Updated webpack output location Reverted helper react.es5.js changes back Added gitignore for react/tests/dist Updated ES6 dependency imports to pancake root folder * Added nuke script for pancake/ * Temporary resolved yarn workspace building by pretending animate requires sass * Added missing sass: name false key to animate * Reverted pretending animate hass sass * Resolved root and core vulnerabilities * Added missing whitespace in core * Updated engines, removed verbose --pancake from animate * Added back webpack ./bundle.js -> bundle.js * Updated local install instructions for yarn and grammar * Updated FAQ notes for yarn * Updated auds.json from latest develop * Upgraded circle node images to latest lts

…nents into feature/generate-readme-from-src

azerella added enhancement New feature or request. submitted by user Issues on behalf of users. documentation Issue or pull request related to documentation. architecture Issue or pull request related to architecture. labels Feb 12, 2019

azerella added this to ✏️ Sprint backlog in Design System via automation Feb 12, 2019

azerella added this to the Sprint 123 milestone Feb 12, 2019

azerella force-pushed the feature/generate-readme-from-src branch from 97a6434 to 5f243f9 Compare February 14, 2019 05:36

Ran npm audit fix

6305ea2

azerella moved this from ✏️ Sprint backlog to 🏗 Doing in Design System Feb 14, 2019

azerella self-assigned this Feb 14, 2019

Adam Zerella added 2 commits February 15, 2019 10:02

Generated react prop markdown table

226a048

Added desc to accordion.js props for testing

azerella force-pushed the feature/generate-readme-from-src branch from 5f243f9 to 226a048 Compare February 15, 2019 05:30

Added FileExists functions to helper.js

71116d3

azerella force-pushed the feature/generate-readme-from-src branch from a2ff439 to 71116d3 Compare February 18, 2019 05:55

Adam A. Zerella added 2 commits February 18, 2019 17:38

Reduced scope of generate-readme script to JUST generate README.md

187d23c

Removed unused deps Made code neater

Updated accordion react file

715b9fe

azerella force-pushed the feature/generate-readme-from-src branch from 51ed8c7 to 715b9fe Compare February 18, 2019 23:38

Resolved rendering raw html and JSX from react source

496d329

Added comments and minor refactoring Updated links, markdown formatting

azerella force-pushed the feature/generate-readme-from-src branch from c382b9b to 496d329 Compare February 19, 2019 02:41

sukhrajghuman modified the milestones: Sprint 123, Sprint 124 Feb 20, 2019

Adam A. Zerella added 4 commits February 20, 2019 11:36

Updated default props and added missing prop defs

5923441

Added @babel/register hook to transpile dynamic imports

226ff84

Updated type checks

Installed @babel/register

3bcbe43

Added more prop descs

b144ec6

azerella mentioned this pull request Feb 20, 2019

Generate CHANGELOG.md #601

Closed

Adam A. Zerella added 3 commits February 22, 2019 09:35

Added render resolver for multiple docs per file

72ae4e5

Updated autoprefixer changed packages for release

4bd9c9c

Adam A. Zerella added 5 commits February 22, 2019 12:18

Corrected release history version

8738d72

Added newline to package.json (how it should be)

bfb1fb8

Updated wording for package changes

808c197

Added Adam Z as contributor to updated packages

736b508

Merge branch 'master' of https://github.com/govau/design-system-compo…

b003c22

…nents into feature/generate-readme-from-src

azerella force-pushed the develop branch 3 times, most recently from 0e8b910 to 9a5b8dc Compare February 25, 2019 23:30

azerella moved this from 🏗 Doing to 🔬 QA in Design System Feb 28, 2019

azerella force-pushed the develop branch 2 times, most recently from c343bcc to 1b6a5f2 Compare March 1, 2019 00:52

sukhrajghuman removed this from the Sprint 124 milestone Mar 5, 2019

azerella changed the title ~~[ WIP ] Generate README.md automagically~~ [WIP] Generate README.md automagically Mar 11, 2019

mattparry moved this from 🔬 QA to ✏️ Sprint backlog in Design System Mar 19, 2019

azerella moved this from ✏️ Sprint backlog to 🌱 Product Backlog in Design System Apr 1, 2019

azerella mentioned this pull request Apr 2, 2019

Move react components into react/ folders #713

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Generate README.md automagically #622

[WIP] Generate README.md automagically #622

azerella commented Feb 12, 2019 •

edited

[WIP] Generate README.md automagically #622

Are you sure you want to change the base?

[WIP] Generate README.md automagically #622

Conversation

azerella commented Feb 12, 2019 • edited

UPDATE: 20/02/2019

Example:

azerella commented Feb 12, 2019 •

edited