e118dda13a
* fix: remove circular dependency redux depended on templates/Challenges/redux and vice versa. This meant that import order mattered and confusing bugs could arise. (cherry picked from commit 7d67a4e70922bbb3051f2f9982dcc69e240d43dc) * feat: require imports to be in alphabetical order Import order generally does not matter, but there are edge cases (circular imports and css imports, for example) where changing order changes behaviour (cherry picked from commit b8d1393a91ec6e068caf8e8498a5c95df68c2b2c) * chore: order imports * fix: lift up challenge description + title comps This brings the classic Show closer to the others as they now all create the description and title components * fix: remove donation-saga/index circular import (cherry picked from commit 51a44ca668a700786d2744feffeae4fdba5fd207) * refactor: extract action-types from settings (cherry picked from commit 25e26124d691c84a0d0827d41dafb761c686fadd) * fix: lint errors * feat: prevent useless renames
76 lines
2.7 KiB
JavaScript
76 lines
2.7 KiB
JavaScript
const directive = require('remark-directive');
|
|
const frontmatter = require('remark-frontmatter');
|
|
const remark = require('remark-parse');
|
|
const { readSync } = require('to-vfile');
|
|
const unified = require('unified');
|
|
const addFrontmatter = require('./plugins/add-frontmatter');
|
|
const addSeed = require('./plugins/add-seed');
|
|
const addSolution = require('./plugins/add-solution');
|
|
const addTests = require('./plugins/add-tests');
|
|
const addText = require('./plugins/add-text');
|
|
const addVideoQuestion = require('./plugins/add-video-question');
|
|
const replaceImports = require('./plugins/replace-imports');
|
|
const restoreDirectives = require('./plugins/restore-directives');
|
|
const tableAndStrikeThrough = require('./plugins/table-and-strikethrough');
|
|
|
|
// by convention, anything that adds to file.data has the name add<name>.
|
|
const processor = unified()
|
|
// add the remark parser
|
|
.use(remark)
|
|
// modify the parser so that Github flavour tables and strikethroughs get
|
|
// converted to 'delete' nodes
|
|
.use(tableAndStrikeThrough)
|
|
// directives are parsed into 'leafDirective' nodes and used for imports
|
|
.use(directive)
|
|
// convert the text at the top of the document (surrounded by ---) into a
|
|
// 'yaml' node
|
|
.use(frontmatter, ['yaml'])
|
|
// extract the content from that 'yaml' node
|
|
.use(addFrontmatter)
|
|
// Any imports will be replaced (in the tree) with
|
|
// the sub-tree of the target file. e.g.
|
|
// ::import{component="Script" from="./file.path" }
|
|
// means that file.path's tree will be inserted wherever
|
|
// ::use{component="Script"}
|
|
// appears.
|
|
.use(replaceImports)
|
|
// the final five 'add' plugins insert content into file.data
|
|
// TODO: rename test->hint everywhere? It should make things easier to reason
|
|
// about.
|
|
.use(addSeed)
|
|
.use(addSolution)
|
|
// the directives will have been parsed and used by this point, any remaining
|
|
// 'directives' will be from text like the css selector :root. These should be
|
|
// converted back to text before they're added to the challenge object.
|
|
.use(restoreDirectives)
|
|
.use(addVideoQuestion)
|
|
.use(addTests)
|
|
.use(addText, ['description', 'instructions']);
|
|
|
|
exports.parseMD = function parseMD(filename) {
|
|
return new Promise((resolve, reject) => {
|
|
const file = readSync(filename);
|
|
const tree = processor.parse(file);
|
|
processor.run(tree, file, function (err, node, file) {
|
|
if (!err) {
|
|
resolve(file.data);
|
|
} else {
|
|
err.message += ' in file ' + filename;
|
|
reject(err);
|
|
}
|
|
});
|
|
});
|
|
};
|
|
|
|
exports.parseMDSync = function parseMDSync(filename) {
|
|
const file = readSync(filename);
|
|
const tree = processor.parse(file);
|
|
try {
|
|
processor.runSync(tree, file);
|
|
} catch (err) {
|
|
err.message += ' in file ' + filename;
|
|
throw err;
|
|
}
|
|
return file.data;
|
|
};
|