feat(v2): migrate bootstrap components to ts #3461

fanny · 2020-09-18T22:19:29Z

Motivation

I would like to define the types of the bootstrap components to typescript, actually, this is part of #2714 change, in order to facilitate the unification process.

Have you read the Contributing Guidelines on pull requests?

(Write your answer here.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

docusaurus-bot · 2020-09-18T22:24:11Z

Deploy preview for docusaurus-2 ready!

Built with commit 3b6c970

https://deploy-preview-3461--docusaurus-2.netlify.app

fanny · 2020-09-18T23:13:10Z

packages/docusaurus-theme-bootstrap/src/theme/DocSidebar/index.tsx

+  item,
+  onItemClick,
+}: DocSidebarItemProps): JSX.Element => {
+  if (item.type === 'category') {


I changed the switch to an if, because typescript can understand what type of the union it is.
PropSidebarItem = PropSidebarItemLink | PropSidebarItemCategory
When we use if, typescript understand which specific type is being used, and allows the access to adequate properties

sure :) didn't know TS was not able to handle discriminated union types with switch

slorber

Thanks @fanny , that looks good :) will just remove the useless log

slorber · 2020-09-29T10:44:13Z

packages/docusaurus-theme-bootstrap/src/theme/DocSidebar/index.tsx

+  item,
+  onItemClick,
+}: DocSidebarItemProps): JSX.Element => {
+  if (item.type === 'category') {


sure :) didn't know TS was not able to handle discriminated union types with switch

packages/docusaurus-theme-bootstrap/src/theme/Navbar/index.tsx

slorber · 2020-09-29T10:45:50Z

packages/docusaurus-theme-bootstrap/src/theme/Navbar/index.tsx

  const {
    siteConfig: {
-      themeConfig: {navbar: {title, links = []} = {}},
+      themeConfig: {navbar: {title = '', items: links = []} = {}},


not urgent right now but we'd rather add themeConfig validation/normalization to bootstrap theme too to make it production ready and avoid putting default values in comps everywhere

* Added powershell command for deployment - specified batch command is for cmd - added powershell as an option for deployment, changed to single quotes * - This affects the following versioned docs: - 2.0.0-alpha.63 - 2.0.0-alpha.64 - Next (Dev) * Changed deploy commands to tabbed - bash, windows, powershell, and cmd are now part of <tabs> - default value is bash * Changed deployment commands to tabs in v63 and 64 - Next (dev) now has better syntax - 2.0.0-alpha-63 and 2.0.0-alpha-64 now include the tabs as well * Updated lables in deploy and cmd to Windows - Labels now are first-letter uppercase - eg. bash -> Bash - cmd is now Windows to align with original docs * Removed `<Tab>` spacing in deploy section - Removed spacing at end of `values` statement - Removed spacing between `<Tabs>` and `<TabItem>` - build successful locally

…versions (#3472)

…heme classic Layout (#3457) * feat(v2): add optional custom wrapper class name for pages based on theme classic Layout * feat(v2): add optional custom wrapper class name for markdown pages * fix TS types

Right now `docusaurus serve my-dir` doesn't work because it's not registered as an internal command, thus always forced to invoked w/ `path.resolve('.')`. This fixes that

There is a small typo in website/docs/cli.md, website/docs/deployment.md, website/versioned_docs/version-2.0.0-alpha.60/cli.md, website/versioned_docs/version-2.0.0-alpha.60/deployment.md, website/versioned_docs/version-2.0.0-alpha.61/cli.md, website/versioned_docs/version-2.0.0-alpha.61/deployment.md, website/versioned_docs/version-2.0.0-alpha.62/cli.md, website/versioned_docs/version-2.0.0-alpha.62/deployment.md, website/versioned_docs/version-2.0.0-alpha.63/cli.md, website/versioned_docs/version-2.0.0-alpha.63/deployment.md, website/versioned_docs/version-2.0.0-alpha.64/cli.md, website/versioned_docs/version-2.0.0-alpha.64/deployment.md. Should read `locally` rather than `localy`.

* feat(v2): add custom title delimiter to the theme classic * fix validation tests * remove title delimiter fallback * move titleDelimiter to main config, update theme-bootstrap * remove test value from config * update test snapshot * Improve docs Co-authored-by: Alexey Pyltsyn <[email protected]>

* Add @theme-init components to user theme * Refactor loadThemeAlias duplicate code to function

* feat: new docusaurus clear command * Update packages/docusaurus/bin/docusaurus.js Co-authored-by: Alexey Pyltsyn <[email protected]> * docs: new docusaurus clear command * fix doc * update monorepo clear cmd * make clear async function wait for deletes to complete + factorize a bit * prettier fix * better clear docs Co-authored-by: Alexey Pyltsyn <[email protected]> Co-authored-by: slorber <[email protected]> Co-authored-by: Sébastien Lorber <[email protected]>

* feat(v2): allow to use array of files in customCss field * customCss array: - fix bug (push instead of concat) - update docs - add theme config validation + tests Co-authored-by: slorber <[email protected]>

* Update README.md Added the MIT License shield and fixed grammatical errors in the documentation. * Update CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md * Update CODE_OF_CONDUCT.md * Update CODE_OF_CONDUCT.md

slorber · 2020-09-29T11:00:28Z

ooh my bad I think I messed up with your branch while trying to resolve the conflicts. Will open another PR with your changes as afaik we are not allowed to force push.

slorber · 2020-09-29T11:05:17Z

Superseeded by #3496

fanny added 4 commits September 18, 2020 17:10

feat(v2): Migrate bootstrap theme to typescript

1a2e073

chore(v2): Add eslint rule to avoid delete import of modules

b28be27

chore(v2): Add lib to gitignore

f07a120

chore(v2): Add prettier script

2426605

facebook-github-bot added the CLA Signed Signed Facebook CLA label Sep 18, 2020

chore(v2): change hooks to ts

a0beafb

fanny commented Sep 18, 2020

View reviewed changes

fanny added 6 commits September 18, 2020 21:17

fix(v2): Fix Navbar and Layout problems

80776ad

fix(v2): scroll

95a607c

fix(v2): navbar metadata

5bdb238

refactor(v2): improve css styles

42f6c04

chore(v2): Restore debug layout

2de807b

feat(v2): Remove console.log

b5b010b

fanny marked this pull request as ready for review September 21, 2020 11:44

fanny requested a review from yangshun as a code owner September 21, 2020 11:44

slorber reviewed Sep 29, 2020

View reviewed changes

slorber and others added 13 commits September 29, 2020 12:51

Update packages/docusaurus-theme-bootstrap/src/theme/Navbar/index.tsx

2e3647b

fix(v2): show dropdown instead of a single button when there are two …

61e3db6

…versions (#3472)

feat(v2): add optional custom wrapper class name for pages based on t…

50daa95

…heme classic Layout (#3457) * feat(v2): add optional custom wrapper class name for pages based on theme classic Layout * feat(v2): add optional custom wrapper class name for markdown pages * fix TS types

chore(v2): remove alpha 58 doc (#3477)

9b1e6af

docs(v2): remove redundant new line in code block (#3479)

0271314

fix(v2): add serve to internal command list (#3451)

403ed8c

Right now `docusaurus serve my-dir` doesn't work because it's not registered as an internal command, thus always forced to invoked w/ `path.resolve('.')`. This fixes that

feat(v2): Add @theme-init components to user theme (#3485)

b6964d5

* Add @theme-init components to user theme * Refactor loadThemeAlias duplicate code to function

feat(v2): allow to use array of files in customCss field (#3474)

93f0f39

* feat(v2): allow to use array of files in customCss field * customCss array: - fix bug (push instead of concat) - update docs - add theme config validation + tests Co-authored-by: slorber <[email protected]>

docs(v2): Added drone.io publish docs #3491 (#3492)

0269120

slorber and others added 3 commits September 29, 2020 12:57

docs(v2): grammar fix (#3493)

0cdafd9

misc: add License to the documentation (#3473)

b95c06b

* Update README.md Added the MIT License shield and fixed grammatical errors in the documentation. * Update CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md * Update CODE_OF_CONDUCT.md * Update CODE_OF_CONDUCT.md

fix(v2): Fix markdownlint rules on template init/README #3465

3b6c970

fanny requested a review from lex111 as a code owner September 29, 2020 10:58

slorber mentioned this pull request Sep 29, 2020

feat(v2): migrate bootstrap components to ts #3496

Merged

slorber closed this Sep 29, 2020

lex111 deleted the fanny/migrate-bootstrap-to-ts branch October 2, 2021 12:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(v2): migrate bootstrap components to ts #3461

feat(v2): migrate bootstrap components to ts #3461

fanny commented Sep 18, 2020

docusaurus-bot commented Sep 18, 2020 •

edited

Loading

fanny Sep 18, 2020 •

edited

Loading

slorber Sep 29, 2020

slorber left a comment

slorber Sep 29, 2020

slorber Sep 29, 2020

slorber commented Sep 29, 2020

slorber commented Sep 29, 2020

feat(v2): migrate bootstrap components to ts #3461

feat(v2): migrate bootstrap components to ts #3461

Conversation

fanny commented Sep 18, 2020

Motivation

Have you read the Contributing Guidelines on pull requests?

Test Plan

Related PRs

docusaurus-bot commented Sep 18, 2020 • edited Loading

fanny Sep 18, 2020 • edited Loading

Choose a reason for hiding this comment

slorber Sep 29, 2020

Choose a reason for hiding this comment

slorber left a comment

Choose a reason for hiding this comment

slorber Sep 29, 2020

Choose a reason for hiding this comment

slorber Sep 29, 2020

Choose a reason for hiding this comment

slorber commented Sep 29, 2020

slorber commented Sep 29, 2020

docusaurus-bot commented Sep 18, 2020 •

edited

Loading

fanny Sep 18, 2020 •

edited

Loading