string | yes |
77 | | bar | This is the description of bar. | number | no |
78 |
79 | ---
80 |
81 | ## Other code behavior
82 |
83 | When the generator sees the `@docs` directive in a JSDoc comment before anything else that isn't an `interface`, it will simply take the declaration and wrap it in a code block with one difference—it will remove the generics from the types (e.g. `foo | this is a description of foo | string | yes |
81 | | bar | | number | no |
82 | | complex | | {
a: Date
b: Animal
} | yes |
83 |
84 | ## \`Animal\`
85 |
86 | makes a sound
87 |
88 | | Name | Description | Type | Required |
89 | | ---------------------- | ----------- | ------------------- | -------- |
90 | | makeSound | | string | yes |
91 |
92 | ## Other code test
93 |
94 | this will have its generics removed
95 |
96 | \`\`\`ts
97 | type OtherCode = Cool & Generic & Thing;
98 | \`\`\`
99 | "
100 | `);
101 | });
102 |
--------------------------------------------------------------------------------
/website/generate-api-docs.js:
--------------------------------------------------------------------------------
1 | const fs = require('fs');
2 | const path = require('path');
3 | const { promisify } = require('util');
4 | const { flatten } = require('lodash');
5 | const readdir = promisify(fs.readdir);
6 | const stat = promisify(fs.stat);
7 | const readFile = promisify(fs.readFile);
8 | const writeFile = promisify(fs.writeFile);
9 | const mkdir = promisify(fs.mkdir);
10 | const generateApiDoc = require('./generate-api-doc');
11 |
12 | async function asyncFilter(array, predicate) {
13 | const result = await Promise.all(
14 | array.map(async (value) => ({
15 | value,
16 | keep: await predicate(value),
17 | })),
18 | );
19 |
20 | return result.filter((x) => x.keep).map((x) => x.value);
21 | }
22 |
23 | function startsWithUppercase(str) {
24 | const first = str[0];
25 | if (!first) return false;
26 | return first === first.toUpperCase();
27 | }
28 |
29 | function isAllCaps(str) {
30 | if (!str) return false;
31 | return str === str.toUpperCase();
32 | }
33 |
34 | function camelToDashed(camel) {
35 | return camel
36 | .split('')
37 | .map((letter, index) =>
38 | letter.toUpperCase() === letter && index !== 0 ? `-${letter}` : letter,
39 | )
40 | .join('')
41 | .toLowerCase();
42 | }
43 |
44 | async function main() {
45 | /**
46 | * @param {string} dir
47 | * @return {string[]}
48 | */
49 | async function findAllTypingsFiles(dir) {
50 | const currentFiles = await readdir(dir);
51 |
52 | const fileNames = flatten(
53 | await Promise.all(
54 | currentFiles.map(async (file) => {
55 | const path = `${dir}/${file}`;
56 | const result = await stat(path);
57 |
58 | if (result.isDirectory()) {
59 | return findAllTypingsFiles(path);
60 | }
61 |
62 | return path;
63 | }),
64 | ),
65 | )
66 | .filter((file) => file.endsWith('.d.ts'))
67 | .filter((file) => !file.endsWith('index.d.ts'));
68 |
69 | return fileNames;
70 | }
71 |
72 | const fileNames = await findAllTypingsFiles(path.resolve(__dirname, '../src'));
73 |
74 | const docFileNames = await asyncFilter(fileNames, async (fileName) => {
75 | const contents = await readFile(fileName);
76 | const text = contents.toString();
77 | return text.includes('@docs');
78 | });
79 |
80 | console.log({ docFileNames });
81 |
82 | for (const docPath of docFileNames) {
83 | const pathSplit = docPath.split('/');
84 | const fileName = pathSplit[pathSplit.length - 1];
85 | const name = fileName.substring(0, fileName.length - '.d.ts'.length);
86 | const id = camelToDashed(name);
87 |
88 | const contents = (await readFile(docPath)).toString();
89 |
90 | const result = generateApiDoc(name, contents);
91 |
92 | try {
93 | await mkdir(path.resolve(__dirname, '../docs/api'));
94 | } catch {}
95 | await writeFile(path.resolve(__dirname, `../docs/api/${id}.md`), result);
96 | }
97 |
98 | const sidebars = JSON.parse(
99 | (await readFile(path.resolve(__dirname, './sidebars.json'))).toString(),
100 | );
101 |
102 | const docIds = docFileNames
103 | .map((docPath) => {
104 | const pathSplit = docPath.split('/');
105 | const fileName = pathSplit[pathSplit.length - 1];
106 | const name = fileName.substring(0, fileName.length - '.d.ts'.length);
107 | const id = camelToDashed(name);
108 |
109 | return { path: `api/${id}`, name };
110 | })
111 | .sort((a, b) => {
112 | if (isAllCaps(a.name) && !isAllCaps(b.name)) return -1;
113 | if (isAllCaps(b.name) && !isAllCaps(a.name)) return 1;
114 | if (startsWithUppercase(a.name) && !startsWithUppercase(b.name)) return -1;
115 | if (startsWithUppercase(b.name) && !startsWithUppercase(a.name)) return 1;
116 | return a.name.localeCompare(b.name);
117 | })
118 | .map((x) => x.path)
119 | .reverse();
120 |
121 | const newSidebars = {
122 | ...sidebars,
123 | docs: {
124 | ...sidebars.docs,
125 | API: ['api/about-api-docs', ...docIds],
126 | },
127 | };
128 |
129 | await writeFile(path.resolve(__dirname, './sidebars.json'), JSON.stringify(newSidebars, null, 2));
130 | }
131 |
132 | main()
133 | .then(() => {
134 | process.exit(0);
135 | })
136 | .catch((e) => {
137 | console.error(e);
138 | process.exit(1);
139 | });
140 |
--------------------------------------------------------------------------------
/website/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "scripts": {
3 | "examples": "docusaurus-examples",
4 | "start": "docusaurus-start",
5 | "build": "node ./generate-api-docs && node ./replaceTwitterCardType && docusaurus-build && echo \"/ /docs/introduction/what-is-resift\" >> ./build/resift/_redirects",
6 | "publish-gh-pages": "docusaurus-publish",
7 | "write-translations": "docusaurus-write-translations",
8 | "version": "docusaurus-version",
9 | "rename-version": "docusaurus-rename-version"
10 | },
11 | "dependencies": {
12 | "common-tags": "^1.8.0",
13 | "docusaurus": "^1.14.0",
14 | "lodash": "^4.17.15",
15 | "markdown-table": "^1.1.3",
16 | "prettier": "^1.18.2",
17 | "typescript": "^3.5.3"
18 | }
19 | }
20 |
--------------------------------------------------------------------------------
/website/pages/en/help.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | const React = require('react');
9 |
10 | const CompLibrary = require('../../core/CompLibrary.js');
11 |
12 | const Container = CompLibrary.Container;
13 | const GridBlock = CompLibrary.GridBlock;
14 |
15 | function Help() {
16 | const supportLinks = [
17 | {
18 | title: 'Found an issue? Have an idea?',
19 | content: `Don't hesitate to [open an issue](https://github.com/JustSift/ReSift/issues/new)`,
20 | },
21 | {
22 | title: 'Have a question?',
23 | content:
24 | 'Ask it on [StackOverflow](https://stackoverflow.com/questions/tagged/resift). Use the tag `resift`',
25 | },
26 | ];
27 |
28 | return (
29 | We're here for you!
36 |