Skip to content

Commit

Permalink
Add ESDoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
basilfx committed Jul 26, 2017
1 parent cfbcc2b commit 0f1dc32
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 12 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
__pycache__
*.pyc

photod-frontend/docs/
photod-frontend/node_modules/
photod-frontend/public
photod-frontend/public/

photod-backend/env/
photod-backend/cache/
Expand Down
5 changes: 4 additions & 1 deletion photod-frontend/esdoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,8 @@
"doExpressions": true,
"asyncGenerators": true,
"exportExtensions": true
}
},
"plugins": [{
"name": "esdoc-flow-plugin"
}]
}
4 changes: 3 additions & 1 deletion photod-frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"compression-webpack-plugin": "*",
"css-loader": "*",
"esdoc": "^0.5.2",
"esdoc-flow-plugin": "^1.0.0",
"eslint": "^4.0.0",
"eslint-config-semistandard": "^11.0.0",
"eslint-config-standard": "^10.2.0",
Expand Down Expand Up @@ -109,6 +110,7 @@
"start-production": "NODE_ENV=production node_modules/.bin/webpack-dev-server --config webpack.config.production.js --port 8000 --progress --hot --inline",
"build": "NODE_ENV=production node_modules/.bin/webpack --config webpack.config.js --bail",
"build-production": "NODE_ENV=production node_modules/.bin/webpack --config webpack.config.production.js --bail",
"build-schema": "apollo-codegen generate src/**/*.js --schema schema.json --target flow --output interfaces/schema.js"
"build-schema": "apollo-codegen generate src/**/*.js --schema schema.json --target flow --output interfaces/schema.js",
"build-docs": "esdoc -c esdoc.json"
}
}
79 changes: 70 additions & 9 deletions photod-frontend/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,32 @@ babel-code-frame@^6.11.0, babel-code-frame@^6.22.0, babel-code-frame@^6.8.0:
esutils "^2.0.2"
js-tokens "^3.0.0"

[email protected]:
version "6.9.1"
resolved "https://registry.yarnpkg.com/babel-core/-/babel-core-6.9.1.tgz#48d471eebf4de469e0a942fe456dcc94b18be80d"
dependencies:
babel-code-frame "^6.8.0"
babel-generator "^6.9.0"
babel-helpers "^6.8.0"
babel-messages "^6.8.0"
babel-register "^6.9.0"
babel-runtime "^6.9.1"
babel-template "^6.9.0"
babel-traverse "^6.9.0"
babel-types "^6.9.1"
babylon "^6.7.0"
convert-source-map "^1.1.0"
debug "^2.1.1"
json5 "^0.4.0"
lodash "^4.2.0"
minimatch "^2.0.3"
path-exists "^1.0.0"
path-is-absolute "^1.0.0"
private "^0.1.6"
shebang-regex "^1.0.0"
slash "^1.0.0"
source-map "^0.5.0"

babel-core@^6.24.1, babel-core@^6.25.0:
version "6.25.0"
resolved "https://registry.yarnpkg.com/babel-core/-/babel-core-6.25.0.tgz#7dd42b0463c742e9d5296deb3ec67a9322dad729"
Expand Down Expand Up @@ -461,7 +487,7 @@ [email protected]:
lodash "^4.2.0"
source-map "^0.5.0"

babel-generator@^6.21.0, babel-generator@^6.25.0:
babel-generator@^6.21.0, babel-generator@^6.25.0, babel-generator@^6.9.0:
version "6.25.0"
resolved "https://registry.yarnpkg.com/babel-generator/-/babel-generator-6.25.0.tgz#33a1af70d5f2890aeb465a4a7793c1df6a9ea9fc"
dependencies:
Expand Down Expand Up @@ -621,7 +647,7 @@ babel-helper-to-multiple-sequence-expressions@^0.1.1:
version "0.1.1"
resolved "https://registry.yarnpkg.com/babel-helper-to-multiple-sequence-expressions/-/babel-helper-to-multiple-sequence-expressions-0.1.1.tgz#5f1b832b39e4acf954e9137f0251395c71196b35"

babel-helpers@^6.24.1:
babel-helpers@^6.24.1, babel-helpers@^6.8.0:
version "6.24.1"
resolved "https://registry.yarnpkg.com/babel-helpers/-/babel-helpers-6.24.1.tgz#3471de9caec388e5c850e597e58a26ddf37602b2"
dependencies:
Expand Down Expand Up @@ -783,14 +809,20 @@ babel-plugin-syntax-export-extensions@^6.8.0:
version "6.13.0"
resolved "https://registry.yarnpkg.com/babel-plugin-syntax-export-extensions/-/babel-plugin-syntax-export-extensions-6.13.0.tgz#70a1484f0f9089a4e84ad44bac353c95b9b12721"

babel-plugin-syntax-flow@^6.18.0:
babel-plugin-syntax-flow@^6.18.0, babel-plugin-syntax-flow@^6.8.0:
version "6.18.0"
resolved "https://registry.yarnpkg.com/babel-plugin-syntax-flow/-/babel-plugin-syntax-flow-6.18.0.tgz#4c3ab20a2af26aa20cd25995c398c4eb70310c8d"

babel-plugin-syntax-function-bind@^6.8.0:
version "6.13.0"
resolved "https://registry.yarnpkg.com/babel-plugin-syntax-function-bind/-/babel-plugin-syntax-function-bind-6.13.0.tgz#48c495f177bdf31a981e732f55adc0bdd2601f46"

[email protected]:
version "6.8.0"
resolved "https://registry.yarnpkg.com/babel-plugin-syntax-jsx/-/babel-plugin-syntax-jsx-6.8.0.tgz#1c5430a488a5046a47c8da1ad631f16afe8d111a"
dependencies:
babel-runtime "^6.0.0"

babel-plugin-syntax-jsx@^6.3.13, babel-plugin-syntax-jsx@^6.8.0:
version "6.18.0"
resolved "https://registry.yarnpkg.com/babel-plugin-syntax-jsx/-/babel-plugin-syntax-jsx-6.18.0.tgz#0af32a9a6e13ca7a3fd5069e62d7b0f58d0d8946"
Expand Down Expand Up @@ -1044,6 +1076,13 @@ babel-plugin-transform-export-extensions@^6.22.0:
babel-plugin-syntax-export-extensions "^6.8.0"
babel-runtime "^6.22.0"

[email protected]:
version "6.8.0"
resolved "https://registry.yarnpkg.com/babel-plugin-transform-flow-strip-types/-/babel-plugin-transform-flow-strip-types-6.8.0.tgz#2351d85e3a52152e1a55d3f08ae635e21ece17a0"
dependencies:
babel-plugin-syntax-flow "^6.8.0"
babel-runtime "^6.0.0"

babel-plugin-transform-flow-strip-types@^6.22.0:
version "6.22.0"
resolved "https://registry.yarnpkg.com/babel-plugin-transform-flow-strip-types/-/babel-plugin-transform-flow-strip-types-6.22.0.tgz#84cb672935d43714fdc32bce84568d87441cf7cf"
Expand Down Expand Up @@ -1299,7 +1338,7 @@ babel-preset-stage-3@^6.24.1:
babel-plugin-transform-exponentiation-operator "^6.24.1"
babel-plugin-transform-object-rest-spread "^6.22.0"

babel-register@^6.24.1:
babel-register@^6.24.1, babel-register@^6.9.0:
version "6.24.1"
resolved "https://registry.yarnpkg.com/babel-register/-/babel-register-6.24.1.tgz#7e10e13a2f71065bdfad5a1787ba45bca6ded75f"
dependencies:
Expand All @@ -1311,14 +1350,14 @@ babel-register@^6.24.1:
mkdirp "^0.5.1"
source-map-support "^0.4.2"

babel-runtime@^6.18.0, babel-runtime@^6.2.0, babel-runtime@^6.22.0, babel-runtime@^6.23.0, babel-runtime@^6.9.0:
babel-runtime@^6.0.0, babel-runtime@^6.18.0, babel-runtime@^6.2.0, babel-runtime@^6.22.0, babel-runtime@^6.23.0, babel-runtime@^6.9.0, babel-runtime@^6.9.1:
version "6.23.0"
resolved "https://registry.yarnpkg.com/babel-runtime/-/babel-runtime-6.23.0.tgz#0a9489f144de70efb3ce4300accdb329e2fc543b"
dependencies:
core-js "^2.4.0"
regenerator-runtime "^0.10.0"

babel-template@^6.24.1, babel-template@^6.25.0, babel-template@^6.3.0, babel-template@^6.7.0:
babel-template@^6.24.1, babel-template@^6.25.0, babel-template@^6.3.0, babel-template@^6.7.0, babel-template@^6.9.0:
version "6.25.0"
resolved "https://registry.yarnpkg.com/babel-template/-/babel-template-6.25.0.tgz#665241166b7c2aa4c619d71e192969552b10c071"
dependencies:
Expand All @@ -1342,7 +1381,7 @@ [email protected]:
invariant "^2.2.0"
lodash "^4.2.0"

babel-traverse@^6.0.20, babel-traverse@^6.20.0, babel-traverse@^6.23.1, babel-traverse@^6.24.1, babel-traverse@^6.25.0:
babel-traverse@^6.0.20, babel-traverse@^6.20.0, babel-traverse@^6.23.1, babel-traverse@^6.24.1, babel-traverse@^6.25.0, babel-traverse@^6.9.0:
version "6.25.0"
resolved "https://registry.yarnpkg.com/babel-traverse/-/babel-traverse-6.25.0.tgz#2257497e2fcd19b89edc13c4c91381f9512496f1"
dependencies:
Expand All @@ -1356,7 +1395,7 @@ babel-traverse@^6.0.20, babel-traverse@^6.20.0, babel-traverse@^6.23.1, babel-tr
invariant "^2.2.0"
lodash "^4.2.0"

babel-types@^6.0.19, babel-types@^6.10.2, babel-types@^6.16.0, babel-types@^6.19.0, babel-types@^6.23.0, babel-types@^6.24.1, babel-types@^6.25.0, babel-types@^6.9.0:
babel-types@^6.0.19, babel-types@^6.10.2, babel-types@^6.16.0, babel-types@^6.19.0, babel-types@^6.23.0, babel-types@^6.24.1, babel-types@^6.25.0, babel-types@^6.9.0, babel-types@^6.9.1:
version "6.25.0"
resolved "https://registry.yarnpkg.com/babel-types/-/babel-types-6.25.0.tgz#70afb248d5660e5d18f811d91c8303b54134a18e"
dependencies:
Expand Down Expand Up @@ -1494,7 +1533,7 @@ bowser@^1.7.1:
version "1.7.1"
resolved "https://registry.yarnpkg.com/bowser/-/bowser-1.7.1.tgz#a4de8f18a1a0dc9531eb2a92a1521fb6a9ba96a5"

brace-expansion@^1.1.7:
brace-expansion@^1.0.0, brace-expansion@^1.1.7:
version "1.1.8"
resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.8.tgz#c07b211c7c952ec1f8efd51a77ef0d1d3990a292"
dependencies:
Expand Down Expand Up @@ -2698,6 +2737,14 @@ escope@^3.6.0:
esrecurse "^4.1.0"
estraverse "^4.1.1"

esdoc-flow-plugin@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/esdoc-flow-plugin/-/esdoc-flow-plugin-1.0.0.tgz#bda1f4fcae4c290bf7b576f3e42ab8c81a3975d3"
dependencies:
babel-core "6.9.1"
babel-plugin-syntax-jsx "6.8.0"
babel-plugin-transform-flow-strip-types "6.8.0"

esdoc@^0.5.2:
version "0.5.2"
resolved "https://registry.yarnpkg.com/esdoc/-/esdoc-0.5.2.tgz#cbfd0b20e3d1cacc23c93c328eed987e21ba0067"
Expand Down Expand Up @@ -4218,6 +4265,10 @@ [email protected], json3@^3.3.2:
version "3.3.2"
resolved "https://registry.yarnpkg.com/json3/-/json3-3.3.2.tgz#3c0434743df93e2f5c42aee7b19bcb483575f4e1"

json5@^0.4.0:
version "0.4.0"
resolved "https://registry.yarnpkg.com/json5/-/json5-0.4.0.tgz#054352e4c4c80c86c0923877d449de176a732c8d"

json5@^0.5.0, json5@^0.5.1:
version "0.5.1"
resolved "https://registry.yarnpkg.com/json5/-/json5-0.5.1.tgz#1eade7acc012034ad84e2396767ead9fa5495821"
Expand Down Expand Up @@ -4774,6 +4825,12 @@ minimalistic-crypto-utils@^1.0.0, minimalistic-crypto-utils@^1.0.1:
dependencies:
brace-expansion "^1.1.7"

minimatch@^2.0.3:
version "2.0.10"
resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-2.0.10.tgz#8d087c39c6b38c001b97fca7ce6d0e1e80afbac7"
dependencies:
brace-expansion "^1.0.0"

[email protected]:
version "0.0.8"
resolved "https://registry.yarnpkg.com/minimist/-/minimist-0.0.8.tgz#857fcabfc3397d2625b8228262e86aa7a011b05d"
Expand Down Expand Up @@ -5255,6 +5312,10 @@ path-case@^2.1.0:
dependencies:
no-case "^2.2.0"

path-exists@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-1.0.0.tgz#d5a8998eb71ef37a74c34eb0d9eba6e878eea081"

path-exists@^2.0.0:
version "2.1.0"
resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-2.1.0.tgz#0feb6c64f0fc518d9a754dd5efb62c7022761f4b"
Expand Down

0 comments on commit 0f1dc32

Please sign in to comment.