gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

refactor: files{} -> challengeFiles[], and key -> fileKey (#43023)

Browse Source 
* fix(client): fix client

* fix propType and add comment

* revert user.json prettification

* slight type refactor and payload correction

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>

* update ChallengeFile type imports

* add cypress test for code-storage

* update test and storage epic

* fix Shaun's tired brain's logic

* refactor with suggestions

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>

* update codeReset

* increate cypress timeout because firefox is slow

* remove unused import to make linter happy

* use focus on editor

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>

* use more specific seletor for cypress editor test

* account for silly null challengeFiles

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
This commit is contained in:
Shaun Hamilton
2021-08-12 19:48:28 +01:00
committed by GitHub
parent 1f62dfe2b3
commit 59f17f237b
41 changed files with 916 additions and 910 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
tools/challenge-parser/parser/plugins/add-seed.test.js
View File

@ -1,4 +1,3 @@
const { isObject } = require('lodash');
const isArray = require('lodash/isArray');
const adjacentKeysAST = require('../__fixtures__/ast-adjacent-keys.json');
@ -32,26 +31,26 @@ describe('add-seed plugin', () => {
expect(typeof plugin).toEqual('function');
});
it('adds a `files` property to `file.data`', () => {
it('adds a `challengeFiles` property to `file.data`', () => {
plugin(simpleAST, file);
expect('files' in file.data).toBe(true);
expect('challengeFiles' in file.data).toBe(true);
});
it('ensures that the `files` property is an object', () => {
it('ensures that the `challengeFiles` property is an array', () => {
plugin(simpleAST, file);
expect(isObject(file.data.files)).toBe(true);
expect(isArray(file.data.challengeFiles)).toBe(true);
});
it('adds test objects to the files array following a schema', () => {
it('adds test objects to the challengeFiles array following a schema', () => {
expect.assertions(17);
plugin(simpleAST, file);
const {
data: { files }
data: { challengeFiles }
} = file;
const testObject = files.indexjs;
const testObject = challengeFiles.find(x => x.fileKey === 'indexjs');
expect(Object.keys(testObject).length).toEqual(8);
expect(testObject).toHaveProperty('key');
expect(typeof testObject['key']).toBe('string');
expect(testObject).toHaveProperty('fileKey');
expect(typeof testObject['fileKey']).toBe('string');
expect(testObject).toHaveProperty('ext');
expect(typeof testObject['ext']).toBe('string');
expect(testObject).toHaveProperty('name');
@ -69,33 +68,32 @@ describe('add-seed plugin', () => {
});
it('parses seeds without ids', () => {
expect.assertions(6);
expect.assertions(3);
plugin(simpleAST, file);
const {
data: { files }
data: { challengeFiles }
} = file;
const { indexjs, indexhtml, indexcss } = files;
const indexjs = challengeFiles.find(x => x.fileKey === 'indexjs');
const indexhtml = challengeFiles.find(x => x.fileKey === 'indexhtml');
const indexcss = challengeFiles.find(x => x.fileKey === 'indexcss');
expect(indexjs.contents).toBe(`var x = 'y';`);
expect(indexjs.key).toBe(`indexjs`);
expect(indexhtml.contents).toBe(`<html>
<body>
</body>
</html>`);
expect(indexhtml.key).toBe(`indexhtml`);
expect(indexcss.contents).toBe(`body {
background: green;
}`);
expect(indexcss.key).toBe(`indexcss`);
});
it('removes region markers from contents', () => {
expect.assertions(2);
plugin(withEditableAST, file);
const {
data: { files }
data: { challengeFiles }
} = file;
const { indexcss } = files;
const indexcss = challengeFiles.find(x => x.fileKey === 'indexcss');
expect(indexcss.contents).not.toMatch('--fcc-editable-region--');
expect(indexcss.editableRegionBoundaries).toEqual([1, 4]);
@ -107,9 +105,11 @@ describe('add-seed plugin', () => {
expect.assertions(3);
plugin(withSeedKeysAST, file);
const {
data: { files }
data: { challengeFiles }
} = file;
const { indexhtml, indexcss, indexjs } = files;
const indexjs = challengeFiles.find(x => x.fileKey === 'indexjs');
const indexhtml = challengeFiles.find(x => x.fileKey === 'indexhtml');
const indexcss = challengeFiles.find(x => x.fileKey === 'indexcss');
expect(indexhtml.id).toBe('');
expect(indexcss.id).toBe('key-for-css');
@ -138,9 +138,11 @@ describe('add-seed plugin', () => {
expect.assertions(3);
plugin(withBeforeAfterAST, file);
const {
data: { files }
data: { challengeFiles }
} = file;
const { indexjs, indexhtml, indexcss } = files;
const indexjs = challengeFiles.find(x => x.fileKey === 'indexjs');
const indexhtml = challengeFiles.find(x => x.fileKey === 'indexhtml');
const indexcss = challengeFiles.find(x => x.fileKey === 'indexcss');
expect(indexjs.head).toBe('');
expect(indexhtml.head).toBe(`<!-- comment -->`);
@ -153,9 +155,11 @@ describe('add-seed plugin', () => {
expect.assertions(3);
plugin(withBeforeAfterAST, file);
const {
data: { files }
data: { challengeFiles }
} = file;
const { indexjs, indexhtml, indexcss } = files;
const indexjs = challengeFiles.find(x => x.fileKey === 'indexjs');
const indexhtml = challengeFiles.find(x => x.fileKey === 'indexhtml');
const indexcss = challengeFiles.find(x => x.fileKey === 'indexcss');
expect(indexjs.tail).toBe(`function teardown(params) {
// after
@ -188,9 +192,11 @@ describe('add-seed plugin', () => {
expect.assertions(6);
plugin(emptyBeforeAST, file);
const {
data: { files }
data: { challengeFiles }
} = file;
const { indexjs, indexhtml, indexcss } = files;
const indexjs = challengeFiles.find(x => x.fileKey === 'indexjs');
const indexhtml = challengeFiles.find(x => x.fileKey === 'indexhtml');
const indexcss = challengeFiles.find(x => x.fileKey === 'indexcss');
expect(indexjs.head).toBe('');
expect(indexjs.tail).toBe('function teardown(params) {\n // after\n}');
@ -204,9 +210,11 @@ describe('add-seed plugin', () => {
expect.assertions(6);
plugin(emptyAfterAST, file);
const {
data: { files }
data: { challengeFiles }
} = file;
const { indexjs, indexhtml, indexcss } = files;
const indexjs = challengeFiles.find(x => x.fileKey === 'indexjs');
const indexhtml = challengeFiles.find(x => x.fileKey === 'indexhtml');
const indexcss = challengeFiles.find(x => x.fileKey === 'indexcss');
expect(indexjs.head).toBe('');
expect(indexjs.tail).toBe('');
@ -234,9 +242,9 @@ describe('add-seed plugin', () => {
expect.assertions(4);
plugin(jsxSeedAST, file);
const {
data: { files }
data: { challengeFiles }
} = file;
const { indexjsx } = files;
const indexjsx = challengeFiles.find(x => x.fileKey === 'indexjsx');
expect(indexjsx.head).toBe(`function setup() {}`);
expect(indexjsx.tail).toBe(`function teardown(params) {
@ -248,7 +256,7 @@ describe('add-seed plugin', () => {
const Button = () => {
return <button> {/* another comment! */} text </button>;
};`);
expect(indexjsx.key).toBe(`indexjsx`);
expect(indexjsx.fileKey).toBe(`indexjsx`);
});
it('combines all the code of a specific language into a single file', () => {