@docfy/ember 0.8.5 → 0.9.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (164) hide show
  1. package/README.md +8 -5
  2. package/addon-main.cjs +4 -0
  3. package/declarations/components/docfy-demo.d.ts +44 -0
  4. package/declarations/components/docfy-demo.d.ts.map +1 -0
  5. package/declarations/components/docfy-link.d.ts +23 -0
  6. package/declarations/components/docfy-link.d.ts.map +1 -0
  7. package/declarations/components/docfy-output.d.ts +24 -0
  8. package/declarations/components/docfy-output.d.ts.map +1 -0
  9. package/declarations/components/docfy-previous-and-next-page.d.ts +23 -0
  10. package/declarations/components/docfy-previous-and-next-page.d.ts.map +1 -0
  11. package/declarations/index.d.ts +7 -0
  12. package/declarations/index.d.ts.map +1 -0
  13. package/declarations/routing.d.ts +3 -0
  14. package/declarations/routing.d.ts.map +1 -0
  15. package/{services → declarations/services}/docfy.d.ts +4 -8
  16. package/declarations/services/docfy.d.ts.map +1 -0
  17. package/declarations/template-registry.d.ts +11 -0
  18. package/declarations/template-registry.d.ts.map +1 -0
  19. package/dist/_app_/components/docfy-demo.js +1 -0
  20. package/dist/_app_/components/docfy-link.js +1 -0
  21. package/dist/_app_/components/docfy-output.js +1 -0
  22. package/dist/_app_/components/docfy-previous-and-next-page.js +1 -0
  23. package/dist/_app_/services/docfy.js +1 -0
  24. package/dist/components/docfy-demo.js +121 -0
  25. package/dist/components/docfy-demo.js.map +1 -0
  26. package/dist/components/docfy-link.js +58 -0
  27. package/dist/components/docfy-link.js.map +1 -0
  28. package/dist/components/docfy-output.js +43 -0
  29. package/dist/components/docfy-output.js.map +1 -0
  30. package/dist/components/docfy-previous-and-next-page.js +27 -0
  31. package/dist/components/docfy-previous-and-next-page.js.map +1 -0
  32. package/dist/index.js +8 -0
  33. package/dist/index.js.map +1 -0
  34. package/dist/output.d.ts +2 -0
  35. package/dist/output.d.ts.map +1 -0
  36. package/dist/output.js +17 -0
  37. package/dist/output.js.map +1 -0
  38. package/dist/routing.js +29 -0
  39. package/dist/routing.js.map +1 -0
  40. package/dist/services/docfy.js +87 -0
  41. package/dist/services/docfy.js.map +1 -0
  42. package/dist/template-registry.js +2 -0
  43. package/dist/template-registry.js.map +1 -0
  44. package/package.json +91 -124
  45. package/-private/find-previous-or-next-page.d.ts +0 -2
  46. package/-private/flat-nested.d.ts +0 -2
  47. package/.docfy-config.js +0 -40
  48. package/addon/-private/find-previous-or-next-page.ts +0 -22
  49. package/addon/-private/flat-nested.ts +0 -18
  50. package/addon/components/docfy-demo/description.hbs +0 -26
  51. package/addon/components/docfy-demo/description.ts +0 -3
  52. package/addon/components/docfy-demo/example.hbs +0 -3
  53. package/addon/components/docfy-demo/example.ts +0 -3
  54. package/addon/components/docfy-demo/snippet.hbs +0 -8
  55. package/addon/components/docfy-demo/snippet.ts +0 -35
  56. package/addon/components/docfy-demo/snippets.hbs +0 -25
  57. package/addon/components/docfy-demo/snippets.ts +0 -27
  58. package/addon/components/docfy-demo.hbs +0 -10
  59. package/addon/components/docfy-demo.ts +0 -7
  60. package/addon/components/docfy-link.hbs +0 -8
  61. package/addon/components/docfy-link.ts +0 -54
  62. package/addon/components/docfy-output.hbs +0 -1
  63. package/addon/components/docfy-output.ts +0 -37
  64. package/addon/components/docfy-previous-and-next-page.hbs +0 -1
  65. package/addon/components/docfy-previous-and-next-page.ts +0 -20
  66. package/addon/helpers/docfy-eq.ts +0 -7
  67. package/addon/index.ts +0 -31
  68. package/addon/output.d.ts +0 -13
  69. package/addon/services/docfy.ts +0 -101
  70. package/app/components/docfy-demo/description.js +0 -1
  71. package/app/components/docfy-demo/example.js +0 -1
  72. package/app/components/docfy-demo/snippet.js +0 -1
  73. package/app/components/docfy-demo/snippets.js +0 -1
  74. package/app/components/docfy-demo.js +0 -1
  75. package/app/components/docfy-link.js +0 -1
  76. package/app/components/docfy-output.js +0 -1
  77. package/app/components/docfy-previous-and-next-page.js +0 -1
  78. package/app/helpers/docfy-eq.js +0 -1
  79. package/app/services/docfy.js +0 -1
  80. package/components/docfy-demo/description.d.ts +0 -3
  81. package/components/docfy-demo/example.d.ts +0 -3
  82. package/components/docfy-demo/snippet.d.ts +0 -13
  83. package/components/docfy-demo/snippets.d.ts +0 -11
  84. package/components/docfy-demo.d.ts +0 -7
  85. package/components/docfy-link.d.ts +0 -15
  86. package/components/docfy-output.d.ts +0 -16
  87. package/components/docfy-previous-and-next-page.d.ts +0 -12
  88. package/config/environment.js +0 -5
  89. package/docs/components/docfy-demo.md +0 -67
  90. package/docs/components/docfy-link-demo/anchor.md +0 -9
  91. package/docs/components/docfy-link-demo/simple.md +0 -7
  92. package/docs/components/docfy-link.md +0 -31
  93. package/docs/components/docfy-output-demo/edit-page.md +0 -54
  94. package/docs/components/docfy-output-demo/flat.md +0 -23
  95. package/docs/components/docfy-output-demo/on-this-page.md +0 -30
  96. package/docs/components/docfy-output-demo/sidebar.md +0 -45
  97. package/docs/components/docfy-output-demo/top-nav.md +0 -35
  98. package/docs/components/docfy-output.md +0 -34
  99. package/docs/components/docfy-previous-and-next-page-demo/scope.md +0 -26
  100. package/docs/components/docfy-previous-and-next-page-demo/simple.md +0 -24
  101. package/docs/components/docfy-previous-and-next-page.md +0 -21
  102. package/docs/configuration.md +0 -57
  103. package/docs/index.md +0 -165
  104. package/docs/writing-demos-demo/demo1.md +0 -18
  105. package/docs/writing-demos.md +0 -109
  106. package/dummy-docs/README.md +0 -140
  107. package/dummy-docs/github-icon.png +0 -0
  108. package/dummy-docs/installation.md +0 -14
  109. package/dummy-docs/introduction.md +0 -30
  110. package/dummy-docs/overview.md +0 -19
  111. package/dummy-docs/packages/core/helpers/genereate-flat-output.md +0 -10
  112. package/dummy-docs/packages/core/helpers/genereate-nested-output.md +0 -12
  113. package/dummy-docs/packages/core/overview.md +0 -19
  114. package/dummy-docs/packages/ember/components/docfy-link-demo/demo1.md +0 -26
  115. package/dummy-docs/packages/ember/components/docfy-link-demo/demo2.md +0 -20
  116. package/dummy-docs/packages/ember/components/docfy-link.md +0 -19
  117. package/dummy-docs/packages/ember/components/docfy-output.md +0 -32
  118. package/dummy-docs/packages/ember/demo/my-ember-demo.md +0 -3
  119. package/dummy-docs/packages/ember/index.md +0 -23
  120. package/dummy-docs/packages/ember/installation.md +0 -14
  121. package/dummy-docs/packages/ember/plugins/manual-demo-insertion-demo/tomster.md +0 -15
  122. package/dummy-docs/packages/ember/plugins/manual-demo-insertion-demo/zoey.md +0 -9
  123. package/dummy-docs/packages/ember/plugins/manual-demo-insertion.md +0 -31
  124. package/dummy-docs/packages/ember/preview.md +0 -20
  125. package/ember-cli-addon.js +0 -3
  126. package/helpers/docfy-eq.d.ts +0 -7
  127. package/index.d.ts +0 -3
  128. package/lib/docfy-output-template.d.ts +0 -1
  129. package/lib/docfy-output-template.js +0 -23
  130. package/lib/get-config.d.ts +0 -7
  131. package/lib/get-config.js +0 -69
  132. package/lib/index.d.ts +0 -1
  133. package/lib/index.js +0 -177
  134. package/lib/plugins/extract-demos-to-components.d.ts +0 -2
  135. package/lib/plugins/extract-demos-to-components.js +0 -149
  136. package/lib/plugins/preview-template.d.ts +0 -2
  137. package/lib/plugins/preview-template.js +0 -41
  138. package/lib/plugins/replace-internal-links-with-docfy-link.d.ts +0 -6
  139. package/lib/plugins/replace-internal-links-with-docfy-link.js +0 -44
  140. package/lib/plugins/types.d.ts +0 -29
  141. package/lib/plugins/types.js +0 -2
  142. package/lib/plugins/utils.d.ts +0 -31
  143. package/lib/plugins/utils.js +0 -139
  144. package/output.d.ts +0 -13
  145. package/src/docfy-output-template.ts +0 -20
  146. package/src/get-config.ts +0 -90
  147. package/src/index.ts +0 -229
  148. package/src/plugins/extract-demos-to-components.ts +0 -196
  149. package/src/plugins/preview-template.ts +0 -54
  150. package/src/plugins/replace-internal-links-with-docfy-link.ts +0 -61
  151. package/src/plugins/types.ts +0 -33
  152. package/src/plugins/utils.ts +0 -188
  153. package/src/tsconfig.json +0 -14
  154. package/src/types/broccoli-bridge.d.ts +0 -11
  155. package/src/types/broccoli-file-creator.d.ts +0 -11
  156. package/src/types/broccoli-funnel.d.ts +0 -19
  157. package/src/types/broccoli-merge-trees.d.ts +0 -13
  158. package/src/types/broccoli-source.d.ts +0 -9
  159. package/src/types/mdast-util-to-string.d.ts +0 -5
  160. package/src/types/unist-util-find.d.ts +0 -8
  161. package/tsconfig.json +0 -42
  162. package/types/dummy/index.d.ts +0 -0
  163. package/types/ember-get-config/index.d.ts +0 -9
  164. package/types/global.d.ts +0 -6
@@ -1,188 +0,0 @@
1
- import { Node } from 'unist';
2
- import u from 'unist-builder';
3
- import { DemoComponent, DemoComponentName } from './types';
4
-
5
- /**
6
- * Creates all the Nodes necessary to render a Demo Component.
7
- *
8
- * It will render something like the follwing:
9
- * ```hbs
10
- * <DocfyDemo as |demo|>
11
- * <demo.Example>
12
- * <ComponentName />
13
- * </demo.Example>
14
- * <demo.Description @title="Heading depth 1" @editUrl="url">
15
- * Demo markdown content
16
- * </demo.Description>
17
- * <demo.Snippets as |Snippet|>
18
- * <Snippet @name="component">
19
- * Code Snippet (with any highlight applied from remark)
20
- * </Snippet>
21
- * </demo.Snippets>
22
- * </DocfyDemo>
23
- * ```
24
- */
25
- export function createDemoNodes(component: DemoComponent): Node[] {
26
- const nodes: Node[] = [
27
- u('html', `<DocfyDemo @id="${component.name.dashCase}" as |demo|>`)
28
- ];
29
-
30
- if (component.description) {
31
- nodes.push(
32
- u(
33
- 'html',
34
- `<demo.Description
35
- ${
36
- component.description.title
37
- ? `@title="${component.description.title}" `
38
- : ''
39
- }${
40
- component.description.editUrl
41
- ? `@editUrl="${component.description.editUrl}"`
42
- : ''
43
- }>`
44
- ),
45
- component.description.ast,
46
- u('html', '</demo.Description>')
47
- );
48
- }
49
-
50
- nodes.push(
51
- u('html', '<demo.Example>'),
52
- u('html', `<${component.name.pascalCase} />`),
53
- u('html', '</demo.Example>')
54
- );
55
-
56
- if (component.chunks.length > 1) {
57
- nodes.push(u('html', '<demo.Snippets as |Snippet|>'));
58
- component.chunks.forEach((chunk) => {
59
- nodes.push(
60
- u('html', `<Snippet @name="${chunk.type}">`),
61
- chunk.snippet,
62
- u('html', '</Snippet>')
63
- );
64
- });
65
- nodes.push(u('html', '</demo.Snippets>'));
66
- } else {
67
- component.chunks.forEach((chunk) => {
68
- nodes.push(
69
- u('html', `<demo.Snippet @name="${chunk.type}">`),
70
- chunk.snippet,
71
- u('html', '</demo.Snippet>')
72
- );
73
- });
74
- }
75
-
76
- nodes.push(u('html', '</DocfyDemo>'));
77
-
78
- return nodes;
79
- }
80
-
81
- const MAP_LANG_TO_EXT = {
82
- javascript: 'js',
83
- typescript: 'ts',
84
- handlebars: 'hbs',
85
- 'html.hbs': 'hbs',
86
- 'html.handlebars': 'hbs'
87
- };
88
-
89
- /*
90
- * It returns the file extension from a lang string.
91
- */
92
- export function getExt(lang: string): string {
93
- lang = lang.toLowerCase();
94
- return MAP_LANG_TO_EXT[lang] || lang;
95
- }
96
-
97
- /*
98
- * Delete a node from a list of nodes
99
- */
100
- export function deleteNode(
101
- nodes: unknown,
102
- nodeToDelete: Node | undefined
103
- ): void {
104
- if (!nodeToDelete) {
105
- return;
106
- }
107
-
108
- if (Array.isArray(nodes)) {
109
- const index = nodes.findIndex((item) => item === nodeToDelete);
110
-
111
- if (index !== -1) {
112
- nodes.splice(index, 1);
113
- }
114
- }
115
- }
116
-
117
- /*
118
- * Replace a node from a list of nodes
119
- */
120
- export function replaceNode(
121
- nodes: unknown,
122
- nodeToDelete: Node,
123
- ...newNodes: Node[]
124
- ): void {
125
- if (Array.isArray(nodes)) {
126
- const index = nodes.findIndex((item) => item === nodeToDelete);
127
-
128
- if (index !== -1) {
129
- nodes.splice(index, 1, ...newNodes);
130
- }
131
- }
132
- }
133
-
134
- /*
135
- * Generate the component name from the source path of the demo
136
- *
137
- * It returns both dash case and pastal case.
138
- * The dash-case can be used for the file name and the PascalCase for the
139
- * rendering of the component.
140
- */
141
- export function generateDemoComponentName(
142
- identifier: string,
143
- seenNames: Set<string>,
144
- tentativeCount = 1
145
- ): DemoComponentName {
146
- const dashCase = identifier
147
- .split('.')[0]
148
- .toLowerCase()
149
- .replace(/\/|\\/g, '-')
150
- .replace(/[^a-zA-Z0-9|-]/g, '');
151
-
152
- const pascalCase = dashCase
153
- .replace(/(\w)(\w*)/g, function (_, g1, g2) {
154
- return `${g1.toUpperCase()}${g2.toLowerCase()}`;
155
- })
156
- .replace(/-/g, '');
157
-
158
- if (seenNames.has(dashCase)) {
159
- return generateDemoComponentName(
160
- `${dashCase}${tentativeCount}`,
161
- seenNames,
162
- tentativeCount + 1
163
- );
164
- }
165
-
166
- seenNames.add(dashCase);
167
- return {
168
- dashCase,
169
- pascalCase
170
- };
171
- }
172
-
173
- /**
174
- * Checks if a property is of type DemoComponent[]
175
- */
176
- export function isDemoComponents(
177
- components: unknown
178
- ): components is DemoComponent[] {
179
- if (
180
- Array.isArray(components) &&
181
- typeof components[0] == 'object' &&
182
- {}.hasOwnProperty.call(components[0], 'name') &&
183
- {}.hasOwnProperty.call(components[0], 'chunks')
184
- ) {
185
- return true;
186
- }
187
- return false;
188
- }
package/src/tsconfig.json DELETED
@@ -1,14 +0,0 @@
1
- {
2
- "extends": "../../../tsconfig.base.json",
3
- "compilerOptions": {
4
- "strict": false,
5
- "baseUrl": ".",
6
- "outDir": "../lib",
7
- "paths": {
8
- "*": ["types/*"]
9
- },
10
- "typeRoots": ["../../../node_modules/@types", "types"],
11
- "types": ["node"]
12
- },
13
- "include": ["**/*", "types/**/*"]
14
- }
@@ -1,11 +0,0 @@
1
- declare module 'broccoli-bridge' {
2
- import Plugin from 'broccoli-plugin';
3
- import { InputNode, Node } from 'broccoli-node-api';
4
-
5
- export default class Funnel extends Plugin {
6
- constructor();
7
-
8
- placeholderFor(name: string): InputNode;
9
- fulfill(name: string, tree: Node): void;
10
- }
11
- }
@@ -1,11 +0,0 @@
1
- declare module 'broccoli-file-creator' {
2
- import Plugin from 'broccoli-plugin';
3
-
4
- export default class WriteFile extends Plugin {
5
- constructor(
6
- filename: string,
7
- content: string,
8
- _options?: Record<string, unknown>
9
- );
10
- }
11
- }
@@ -1,19 +0,0 @@
1
- declare module 'broccoli-funnel' {
2
- import Plugin from 'broccoli-plugin';
3
- import { InputNode } from 'broccoli-node-api';
4
-
5
- interface Options {
6
- annotation?: string;
7
- srcDir?: string;
8
- destDir?: string;
9
- allowEmpty?: boolean;
10
- include?: (string | RegExp | ((arg0: string) => boolean))[];
11
- exclude?: (string | ((arg0: string) => boolean))[];
12
- files?: string[];
13
- getDestinationPath?(file: string): string;
14
- }
15
-
16
- export default class Funnel extends Plugin {
17
- constructor(inputNode: InputNode, options?: Options);
18
- }
19
- }
@@ -1,13 +0,0 @@
1
- declare module 'broccoli-merge-trees' {
2
- import Plugin from 'broccoli-plugin';
3
- import { InputNode } from 'broccoli-node-api';
4
- import { PluginOptions } from 'broccoli-plugin/dist/interfaces';
5
-
6
- interface Options extends PluginOptions {
7
- overwrite?: boolean;
8
- }
9
-
10
- export default class MergeTrees extends Plugin {
11
- constructor(inputNodes: InputNode[], options?: Options);
12
- }
13
- }
@@ -1,9 +0,0 @@
1
- declare module 'broccoli-source' {
2
- import { PluginOptions } from 'broccoli-plugin/dist/interfaces';
3
- import Plugin from 'broccoli-plugin';
4
- import { InputNode } from 'broccoli-node-api';
5
-
6
- export class UnwatchedDir extends Plugin {
7
- constructor(inputNode: InputNode, options?: PluginOptions);
8
- }
9
- }
@@ -1,5 +0,0 @@
1
- declare module 'mdast-util-to-string' {
2
- import { Node } from 'unist';
3
-
4
- export default function (ast: Node): string;
5
- }
@@ -1,8 +0,0 @@
1
- declare module 'unist-util-find' {
2
- import { Node } from 'unist';
3
-
4
- export default function (
5
- ast: Node,
6
- condition: string | Record<string, unknown> | ((node: Node) => boolean)
7
- ): Node | undefined;
8
- }
package/tsconfig.json DELETED
@@ -1,42 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "target": "es2017",
4
- "allowJs": true,
5
- "moduleResolution": "node",
6
- "allowSyntheticDefaultImports": true,
7
- "noImplicitAny": true,
8
- "noImplicitThis": true,
9
- "alwaysStrict": true,
10
- "strictNullChecks": true,
11
- "strictPropertyInitialization": true,
12
- "skipLibCheck": true,
13
- "noFallthroughCasesInSwitch": true,
14
- "noUnusedLocals": true,
15
- "noUnusedParameters": true,
16
- "noImplicitReturns": true,
17
- "noEmitOnError": false,
18
- "noEmit": true,
19
- "inlineSourceMap": true,
20
- "inlineSources": true,
21
- "baseUrl": ".",
22
- "module": "es6",
23
- "experimentalDecorators": true,
24
- "paths": {
25
- "dummy/tests/*": ["tests/*"],
26
- "dummy/*": ["tests/dummy/app/*", "app/*"],
27
- "@docfy/ember": ["addon"],
28
- "@docfy/ember/*": ["addon/*"],
29
- "@docfy/ember/test-support": ["addon-test-support"],
30
- "@docfy/ember/test-support/*": ["addon-test-support/*"],
31
- "*": ["types/*"]
32
- }
33
- },
34
- "include": [
35
- "app/**/*",
36
- "addon/**/*",
37
- "tests/**/*",
38
- "types/**/*",
39
- "test-support/**/*",
40
- "addon-test-support/**/*"
41
- ]
42
- }
File without changes
@@ -1,9 +0,0 @@
1
- declare const config: {
2
- environment: string;
3
- modulePrefix: string;
4
- podModulePrefix: string;
5
- locationType: string;
6
- rootURL: string;
7
- };
8
-
9
- export default config;
package/types/global.d.ts DELETED
@@ -1,6 +0,0 @@
1
- // Types for compiled templates
2
- declare module '@docfy/ember/templates/*' {
3
- import { TemplateFactory } from 'htmlbars-inline-precompile';
4
- const tmpl: TemplateFactory;
5
- export default tmpl;
6
- }