From 373a486a1456fdb8d0bbb96463e633fa34ef4a9c Mon Sep 17 00:00:00 2001 From: Samy Pesse Date: Mon, 17 Oct 2016 18:24:29 +0200 Subject: [PATCH] Replace GitBook.Shapes by GitBook.PropTypes --- docs/api/node.md | 2 +- .../gitbook-core/src/components/ContextProvider.js | 2 +- packages/gitbook-core/src/components/Link.js | 4 ++-- packages/gitbook-core/src/index.js | 4 ++-- packages/gitbook-core/src/lib/connect.js | 2 +- packages/gitbook-core/src/lib/renderWithContext.js | 2 +- .../gitbook-core/src/{shapes => propTypes}/Context.js | 0 .../gitbook-core/src/{shapes => propTypes}/File.js | 0 .../gitbook-core/src/{shapes => propTypes}/History.js | 0 .../gitbook-core/src/{shapes => propTypes}/Language.js | 0 .../src/{shapes => propTypes}/Languages.js | 0 .../gitbook-core/src/{shapes => propTypes}/Location.js | 0 .../gitbook-core/src/{shapes => propTypes}/Page.js | 0 .../gitbook-core/src/{shapes => propTypes}/Readme.js | 0 .../gitbook-core/src/{shapes => propTypes}/Summary.js | 0 .../src/{shapes => propTypes}/SummaryArticle.js | 0 .../src/{shapes => propTypes}/SummaryPart.js | 0 .../gitbook-core/src/{shapes => propTypes}/i18n.js | 0 .../gitbook-core/src/{shapes => propTypes}/index.js | 0 packages/gitbook-plugin-copy-code/src/index.js | 2 +- packages/gitbook-plugin-search/src/components/Input.js | 4 ++-- .../gitbook-plugin-search/src/components/Results.js | 4 ++-- .../src/components/SharingButtons.js | 2 +- .../src/components/Body.js | 4 ++-- .../src/components/Page.js | 2 +- .../src/components/Sidebar.js | 2 +- .../src/components/Summary.js | 10 +++++----- .../src/components/Theme.js | 8 ++++---- .../src/components/Toolbar.js | 2 +- 29 files changed, 28 insertions(+), 28 deletions(-) rename packages/gitbook-core/src/{shapes => propTypes}/Context.js (100%) rename packages/gitbook-core/src/{shapes => propTypes}/File.js (100%) rename packages/gitbook-core/src/{shapes => propTypes}/History.js (100%) rename packages/gitbook-core/src/{shapes => propTypes}/Language.js (100%) rename packages/gitbook-core/src/{shapes => propTypes}/Languages.js (100%) rename packages/gitbook-core/src/{shapes => propTypes}/Location.js (100%) rename packages/gitbook-core/src/{shapes => propTypes}/Page.js (100%) rename packages/gitbook-core/src/{shapes => propTypes}/Readme.js (100%) rename packages/gitbook-core/src/{shapes => propTypes}/Summary.js (100%) rename packages/gitbook-core/src/{shapes => propTypes}/SummaryArticle.js (100%) rename packages/gitbook-core/src/{shapes => propTypes}/SummaryPart.js (100%) rename packages/gitbook-core/src/{shapes => propTypes}/i18n.js (100%) rename packages/gitbook-core/src/{shapes => propTypes}/index.js (100%) diff --git a/docs/api/node.md b/docs/api/node.md index 99bf1a792..be0cce209 100644 --- a/docs/api/node.md +++ b/docs/api/node.md @@ -1,4 +1,4 @@ -# Context and APIs +# Node APIs GitBooks provides different Node APIs and contexts to plugins. These APIs can vary according to the GitBook version being used, your plugin should specify the `engines.gitbook` field in `package.json` accordingly. diff --git a/packages/gitbook-core/src/components/ContextProvider.js b/packages/gitbook-core/src/components/ContextProvider.js index 86c8d41df..96a44e32c 100644 --- a/packages/gitbook-core/src/components/ContextProvider.js +++ b/packages/gitbook-core/src/components/ContextProvider.js @@ -1,7 +1,7 @@ const React = require('react'); const { Provider } = require('react-redux'); -const ContextShape = require('../shapes/Context'); +const ContextShape = require('../propTypes/Context'); /** * React component to provide a GitBook context to children components. diff --git a/packages/gitbook-core/src/components/Link.js b/packages/gitbook-core/src/components/Link.js index 65f4eb524..ab364bbf0 100644 --- a/packages/gitbook-core/src/components/Link.js +++ b/packages/gitbook-core/src/components/Link.js @@ -3,8 +3,8 @@ const ReactRedux = require('react-redux'); const File = require('../models/File'); const SummaryArticle = require('../models/SummaryArticle'); -const SummaryArticleShape = require('../shapes/SummaryArticle'); -const FileShape = require('../shapes/File'); +const SummaryArticleShape = require('../propTypes/SummaryArticle'); +const FileShape = require('../propTypes/File'); const Link = React.createClass({ propTypes: { diff --git a/packages/gitbook-core/src/index.js b/packages/gitbook-core/src/index.js index a1782e001..7b7415058 100644 --- a/packages/gitbook-core/src/index.js +++ b/packages/gitbook-core/src/index.js @@ -23,7 +23,7 @@ const I18nProvider = require('./components/I18nProvider'); const ACTIONS = require('./actions/TYPES'); -const Shapes = require('./shapes'); +const PropTypes = require('./propTypes'); const connect = require('./lib/connect'); const createPlugin = require('./lib/createPlugin'); const createReducer = require('./lib/createReducer'); @@ -63,7 +63,7 @@ module.exports = { Backdrop, Tooltipped, // Utilities - Shapes, + PropTypes, // Librairies React, Immutable, diff --git a/packages/gitbook-core/src/lib/connect.js b/packages/gitbook-core/src/lib/connect.js index 2f2a212a7..a34299d83 100644 --- a/packages/gitbook-core/src/lib/connect.js +++ b/packages/gitbook-core/src/lib/connect.js @@ -2,7 +2,7 @@ const React = require('react'); const ReactRedux = require('react-redux'); const { injectIntl } = require('react-intl'); -const ContextShape = require('../shapes/Context'); +const ContextShape = require('../propTypes/Context'); /** * Use the GitBook context provided by ContextProvider to map actions to props diff --git a/packages/gitbook-core/src/lib/renderWithContext.js b/packages/gitbook-core/src/lib/renderWithContext.js index c84c221cd..dc7e1f20c 100644 --- a/packages/gitbook-core/src/lib/renderWithContext.js +++ b/packages/gitbook-core/src/lib/renderWithContext.js @@ -5,7 +5,7 @@ const PJAXWrapper = require('../components/PJAXWrapper'); const I18nProvider = require('../components/I18nProvider'); const ContextProvider = require('../components/ContextProvider'); const History = require('../actions/history'); -const contextShape = require('../shapes/context'); +const contextShape = require('../propTypes/context'); const GitBookApplication = React.createClass({ propTypes: { diff --git a/packages/gitbook-core/src/shapes/Context.js b/packages/gitbook-core/src/propTypes/Context.js similarity index 100% rename from packages/gitbook-core/src/shapes/Context.js rename to packages/gitbook-core/src/propTypes/Context.js diff --git a/packages/gitbook-core/src/shapes/File.js b/packages/gitbook-core/src/propTypes/File.js similarity index 100% rename from packages/gitbook-core/src/shapes/File.js rename to packages/gitbook-core/src/propTypes/File.js diff --git a/packages/gitbook-core/src/shapes/History.js b/packages/gitbook-core/src/propTypes/History.js similarity index 100% rename from packages/gitbook-core/src/shapes/History.js rename to packages/gitbook-core/src/propTypes/History.js diff --git a/packages/gitbook-core/src/shapes/Language.js b/packages/gitbook-core/src/propTypes/Language.js similarity index 100% rename from packages/gitbook-core/src/shapes/Language.js rename to packages/gitbook-core/src/propTypes/Language.js diff --git a/packages/gitbook-core/src/shapes/Languages.js b/packages/gitbook-core/src/propTypes/Languages.js similarity index 100% rename from packages/gitbook-core/src/shapes/Languages.js rename to packages/gitbook-core/src/propTypes/Languages.js diff --git a/packages/gitbook-core/src/shapes/Location.js b/packages/gitbook-core/src/propTypes/Location.js similarity index 100% rename from packages/gitbook-core/src/shapes/Location.js rename to packages/gitbook-core/src/propTypes/Location.js diff --git a/packages/gitbook-core/src/shapes/Page.js b/packages/gitbook-core/src/propTypes/Page.js similarity index 100% rename from packages/gitbook-core/src/shapes/Page.js rename to packages/gitbook-core/src/propTypes/Page.js diff --git a/packages/gitbook-core/src/shapes/Readme.js b/packages/gitbook-core/src/propTypes/Readme.js similarity index 100% rename from packages/gitbook-core/src/shapes/Readme.js rename to packages/gitbook-core/src/propTypes/Readme.js diff --git a/packages/gitbook-core/src/shapes/Summary.js b/packages/gitbook-core/src/propTypes/Summary.js similarity index 100% rename from packages/gitbook-core/src/shapes/Summary.js rename to packages/gitbook-core/src/propTypes/Summary.js diff --git a/packages/gitbook-core/src/shapes/SummaryArticle.js b/packages/gitbook-core/src/propTypes/SummaryArticle.js similarity index 100% rename from packages/gitbook-core/src/shapes/SummaryArticle.js rename to packages/gitbook-core/src/propTypes/SummaryArticle.js diff --git a/packages/gitbook-core/src/shapes/SummaryPart.js b/packages/gitbook-core/src/propTypes/SummaryPart.js similarity index 100% rename from packages/gitbook-core/src/shapes/SummaryPart.js rename to packages/gitbook-core/src/propTypes/SummaryPart.js diff --git a/packages/gitbook-core/src/shapes/i18n.js b/packages/gitbook-core/src/propTypes/i18n.js similarity index 100% rename from packages/gitbook-core/src/shapes/i18n.js rename to packages/gitbook-core/src/propTypes/i18n.js diff --git a/packages/gitbook-core/src/shapes/index.js b/packages/gitbook-core/src/propTypes/index.js similarity index 100% rename from packages/gitbook-core/src/shapes/index.js rename to packages/gitbook-core/src/propTypes/index.js diff --git a/packages/gitbook-plugin-copy-code/src/index.js b/packages/gitbook-plugin-copy-code/src/index.js index 4f900787f..73d46c6d1 100644 --- a/packages/gitbook-plugin-copy-code/src/index.js +++ b/packages/gitbook-plugin-copy-code/src/index.js @@ -23,7 +23,7 @@ function getChildrenToText(children) { let CodeBlockWithCopy = React.createClass({ propTypes: { children: React.PropTypes.node, - i18n: GitBook.Shapes.I18n + i18n: GitBook.PropTypes.I18n }, getInitialState() { diff --git a/packages/gitbook-plugin-search/src/components/Input.js b/packages/gitbook-plugin-search/src/components/Input.js index 457deff7a..22351ccb5 100644 --- a/packages/gitbook-plugin-search/src/components/Input.js +++ b/packages/gitbook-plugin-search/src/components/Input.js @@ -6,8 +6,8 @@ const search = require('../actions/search'); const SearchInput = React.createClass({ propTypes: { query: React.PropTypes.string, - i18n: GitBook.Shapes.I18n, - dispatch: GitBook.Shapes.dispatch + i18n: GitBook.PropTypes.I18n, + dispatch: GitBook.PropTypes.dispatch }, onChange(event) { diff --git a/packages/gitbook-plugin-search/src/components/Results.js b/packages/gitbook-plugin-search/src/components/Results.js index ddff87dc5..16a8cbdd6 100644 --- a/packages/gitbook-plugin-search/src/components/Results.js +++ b/packages/gitbook-plugin-search/src/components/Results.js @@ -42,8 +42,8 @@ const Result = React.createClass({ const SearchResults = React.createClass({ propTypes: { - i18n: GitBook.Shapes.I18n, - results: GitBook.Shapes.list, + i18n: GitBook.PropTypes.I18n, + results: GitBook.PropTypes.list, query: React.PropTypes.string, children: React.PropTypes.node }, diff --git a/packages/gitbook-plugin-sharing/src/components/SharingButtons.js b/packages/gitbook-plugin-sharing/src/components/SharingButtons.js index 445458a94..4f5ada913 100644 --- a/packages/gitbook-plugin-sharing/src/components/SharingButtons.js +++ b/packages/gitbook-plugin-sharing/src/components/SharingButtons.js @@ -12,7 +12,7 @@ const ShareButton = require('./ShareButton'); const SharingButtons = React.createClass({ propTypes: { options: optionsShape.isRequired, - page: GitBook.Shapes.Page.isRequired + page: GitBook.PropTypes.Page.isRequired }, onShare(site) { diff --git a/packages/gitbook-plugin-theme-default/src/components/Body.js b/packages/gitbook-plugin-theme-default/src/components/Body.js index 4f51f0faa..2eba09a2d 100644 --- a/packages/gitbook-plugin-theme-default/src/components/Body.js +++ b/packages/gitbook-plugin-theme-default/src/components/Body.js @@ -6,8 +6,8 @@ const Toolbar = require('./Toolbar'); const Body = React.createClass({ propTypes: { - page: GitBook.Shapes.Page, - readme: GitBook.Shapes.Readme + page: GitBook.PropTypes.Page, + readme: GitBook.PropTypes.Readme }, render() { diff --git a/packages/gitbook-plugin-theme-default/src/components/Page.js b/packages/gitbook-plugin-theme-default/src/components/Page.js index 8e4324c3a..cbce70488 100644 --- a/packages/gitbook-plugin-theme-default/src/components/Page.js +++ b/packages/gitbook-plugin-theme-default/src/components/Page.js @@ -3,7 +3,7 @@ const { React } = GitBook; const Page = React.createClass({ propTypes: { - page: GitBook.Shapes.Page + page: GitBook.PropTypes.Page }, render() { diff --git a/packages/gitbook-plugin-theme-default/src/components/Sidebar.js b/packages/gitbook-plugin-theme-default/src/components/Sidebar.js index 4a7fa53d3..ad1754ec4 100644 --- a/packages/gitbook-plugin-theme-default/src/components/Sidebar.js +++ b/packages/gitbook-plugin-theme-default/src/components/Sidebar.js @@ -5,7 +5,7 @@ const Summary = require('./Summary'); const Sidebar = React.createClass({ propTypes: { - summary: GitBook.Shapes.Summary + summary: GitBook.PropTypes.Summary }, render() { diff --git a/packages/gitbook-plugin-theme-default/src/components/Summary.js b/packages/gitbook-plugin-theme-default/src/components/Summary.js index d0fbde636..ef6ab3fb9 100644 --- a/packages/gitbook-plugin-theme-default/src/components/Summary.js +++ b/packages/gitbook-plugin-theme-default/src/components/Summary.js @@ -5,7 +5,7 @@ const { React } = GitBook; let SummaryArticle = React.createClass({ propTypes: { active: React.PropTypes.bool, - article: GitBook.Shapes.SummaryArticle + article: GitBook.PropTypes.SummaryArticle }, render() { @@ -33,7 +33,7 @@ SummaryArticle = GitBook.connect(SummaryArticle, ({page}, {article}) => { const SummaryArticles = React.createClass({ propTypes: { - articles: GitBook.Shapes.listOf(GitBook.Shapes.SummaryArticle) + articles: GitBook.PropTypes.listOf(GitBook.PropTypes.SummaryArticle) }, render() { @@ -51,7 +51,7 @@ const SummaryArticles = React.createClass({ const SummaryPart = React.createClass({ propTypes: { - part: GitBook.Shapes.SummaryPart + part: GitBook.PropTypes.SummaryPart }, render() { @@ -73,7 +73,7 @@ const SummaryPart = React.createClass({ const SummaryParts = React.createClass({ propTypes: { - parts: GitBook.Shapes.listOf(GitBook.Shapes.SummaryPart) + parts: GitBook.PropTypes.listOf(GitBook.PropTypes.SummaryPart) }, render() { @@ -91,7 +91,7 @@ const SummaryParts = React.createClass({ const Summary = React.createClass({ propTypes: { - summary: GitBook.Shapes.Summary + summary: GitBook.PropTypes.Summary }, render() { diff --git a/packages/gitbook-plugin-theme-default/src/components/Theme.js b/packages/gitbook-plugin-theme-default/src/components/Theme.js index 741b3ccbe..8f5dce693 100644 --- a/packages/gitbook-plugin-theme-default/src/components/Theme.js +++ b/packages/gitbook-plugin-theme-default/src/components/Theme.js @@ -8,10 +8,10 @@ const LoadingBar = require('./LoadingBar'); const Theme = React.createClass({ propTypes: { // State - page: GitBook.Shapes.Page, - summary: GitBook.Shapes.Summary, - readme: GitBook.Shapes.Readme, - history: GitBook.Shapes.History, + page: GitBook.PropTypes.Page, + summary: GitBook.PropTypes.Summary, + readme: GitBook.PropTypes.Readme, + history: GitBook.PropTypes.History, sidebar: React.PropTypes.object, // Other props children: React.PropTypes.node diff --git a/packages/gitbook-plugin-theme-default/src/components/Toolbar.js b/packages/gitbook-plugin-theme-default/src/components/Toolbar.js index cb9054981..298017d63 100644 --- a/packages/gitbook-plugin-theme-default/src/components/Toolbar.js +++ b/packages/gitbook-plugin-theme-default/src/components/Toolbar.js @@ -7,7 +7,7 @@ const Toolbar = React.createClass({ propTypes: { title: React.PropTypes.string.isRequired, dispatch: React.PropTypes.func, - readme: GitBook.Shapes.Readme + readme: GitBook.PropTypes.Readme }, onToggle() {