Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(design-system): FileExplorer #15513

Merged
merged 27 commits into from
Mar 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
f1a4901
wip: cleaning up the specs list and swapping it to be a filetree
JessicaSachs Mar 15, 2021
d1bc1ec
Merge branch 'develop' into feat/spec-list-runner-ct
lmiller1990 Mar 15, 2021
032652a
wip: refactor
lmiller1990 Mar 16, 2021
4032a76
wip: refactor
lmiller1990 Mar 16, 2021
228fe88
wip: work on refactor
lmiller1990 Mar 16, 2021
98c62f8
chore: improve types
lmiller1990 Mar 16, 2021
e882438
styling
lmiller1990 Mar 16, 2021
024ed22
chore: remove all references to Cypress in tree list
lmiller1990 Mar 16, 2021
364f937
chore: remove all references to Cypress in tree list
lmiller1990 Mar 16, 2021
43070d8
extract spec list component
lmiller1990 Mar 16, 2021
7d8a2d3
write some tests
lmiller1990 Mar 16, 2021
24985b4
correctly update state
lmiller1990 Mar 16, 2021
bbae2dd
chore: refactor
lmiller1990 Mar 16, 2021
c36aa44
update test
lmiller1990 Mar 16, 2021
6eca2bf
make props optional
lmiller1990 Mar 16, 2021
66fdee3
Merge branch 'develop' into feat/spec-list-refactor
JessicaSachs Mar 16, 2021
ba6faa3
optimizations
lmiller1990 Mar 17, 2021
0713905
add back search
lmiller1990 Mar 17, 2021
b44f46f
Merge branch 'feat/spec-list-refactor' of https://github.com/cypress-…
lmiller1990 Mar 17, 2021
0dce853
use memo
lmiller1990 Mar 17, 2021
50a6525
run spec
lmiller1990 Mar 17, 2021
dd9f517
run spec
lmiller1990 Mar 17, 2021
5a9f421
fix a11l nav
lmiller1990 Mar 17, 2021
83beeac
add tests for spec list a11y nav
lmiller1990 Mar 17, 2021
4512aa7
fix tests:
lmiller1990 Mar 17, 2021
1a18b70
remove unused
lmiller1990 Mar 17, 2021
1d34aa7
update version
lmiller1990 Mar 17, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions npm/design-system/.mocharc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"watch-ignore": [
"./test/_test-output",
"node_modules"
],
"require": "ts-node/register",
"exit": true
}
3 changes: 1 addition & 2 deletions npm/design-system/cypress.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,5 @@
"componentFolder": "src",
"experimentalComponentTesting": true,
"experimentalFetchPolyfill": true,
"fixturesFolder": false,
"supportFile": false
"fixturesFolder": false
}
2 changes: 2 additions & 0 deletions npm/design-system/cypress/support/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import 'regenerator-runtime/runtime'
import 'cypress-real-events/support'
4 changes: 4 additions & 0 deletions npm/design-system/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
"@fortawesome/free-brands-svg-icons": "5.15.2",
"@fortawesome/free-solid-svg-icons": "5.15.2",
"@fortawesome/react-fontawesome": "0.1.14",
"@iconify/icons-vscode-icons": "1.1.1",
"@iconify/react": "2.0.0-rc.8",
"classnames": "2.2.6",
"debug": "4.3.2"
},
Expand All @@ -41,6 +43,8 @@
"babel-loader": "8.0.6",
"css-loader": "2.1.1",
"cypress": "0.0.0-development",
"cypress-real-events": "1.1.0",
"mocha": "^7.0.1",
"react": "16.8.6",
"react-dom": "16.8.6",
"rollup": "^2.38.5",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
@use '../../index.scss' as *;

.nav {
user-select: none;
white-space: nowrap;
}

.ul {
margin-block-start: 0;
margin-block-end: 0;
margin-inline-start: 0;
margin-inline-end: 0;
padding-inline-start: 0;
&:before {
display: none;
}
}

.li.li {
padding-left: 20px;
}


.ul, .li {
position: relative;
list-style: none;
font-size: $text-s;
line-height: 1.6;
}

.a {
position: relative;
color: unset;
text-decoration: none;
display: inline-block;
width: 100%;
&:hover {
cursor: pointer;
}
}

.ul .ul {
margin-inline-start: $text-xs;
}

.isSelected, .isSelected:hover {
text-decoration: underline;
}
130 changes: 130 additions & 0 deletions npm/design-system/src/components/FileExplorer/FileExplorer.spec.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
import { mount } from '@cypress/react'
import React from 'react'
import { FileExplorer, FileComponentProps, FolderComponentProps } from './FileExplorer'
import { FileNode, makeFileHierarchy, TreeNode } from './helpers/makeFileHierarchy'

import styles from './FileExplorer.module.scss'

const specs: Cypress.Cypress['spec'][] = [
{
relative: 'foo/bar/foo.spec.js',
absolute: 'Users/code/foo/bar/foo.spec.js',
name: 'foo/bar/foo.spec.js',
},
{
relative: 'bar/foo.spec.tsx',
absolute: 'bar/foo.spec.tsx',
name: 'bar/foo.spec.tsx',
},
{
relative: 'merp/map.spec.ts',
absolute: 'merp/map.spec.ts',
name: 'merp/map.spec.ts',
},
]

interface FileExplorerTestProps {
clickFileStub: typeof cy.stub
clickFolderStub: typeof cy.stub
}

function createFileExplorer (testProps: FileExplorerTestProps): React.FC {
return () => {
const [selectedFile, setSelectedFile] = React.useState<string>()

const onFileClick = (file: FileNode) => {
setSelectedFile(file.absolute)
}

const files = makeFileHierarchy(specs.map((spec) => spec.relative))

const FileComponent: React.FC<FileComponentProps> = (props) => {
return (
<div onClick={() => {
testProps.clickFileStub(props.item)
props.onClick(props.item)
}}>
{props.item.name}
</div>
)
}

const FolderComponent: React.FC<FolderComponentProps> = (props) => {
return (
<div onClick={() => {
testProps.clickFolderStub()
props.onClick()
}}>
{props.item.name}
</div>
)
}
Comment on lines +41 to +61
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In ideal (non-test) usage, these would be statically defined at the module level, rather than inline. Alternatively, they could be memoed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, this is just for testing purposes. We should make a new component in practice. I'll make this change in the other file where they are declared inline.


return (
<FileExplorer
files={files}
cssModule={styles}
selectedFile={selectedFile}
fileComponent={FileComponent}
folderComponent={FolderComponent}
onFileClick={onFileClick}
/>
)
}
}

describe('FileExplorer', () => {
it('basic usage', () => {
const files: TreeNode[] = [
{
type: 'folder',
name: 'foo',
absolute: 'foo',
files: [
{
type: 'file',
name: 'bar.js',
absolute: 'foo/bar.js',
},
],
},
]

const FileComponent: React.FC<FileComponentProps> = (props) => <div>{props.item.name}</div>
const FolderComponent: React.FC<FolderComponentProps> = (props) => <div>{props.item.name}</div>

mount(
<FileExplorer
files={files}
selectedFile={undefined}
fileComponent={FileComponent}
folderComponent={FolderComponent}
onFileClick={() => {}}
/>,
)
})

it('clicks file and folders', () => {
const clickFolderStub = cy.stub()
const clickFileStub = cy.stub()

const Wrapper = createFileExplorer({
clickFolderStub,
clickFileStub,
})

mount(<Wrapper />)

cy.get('div').contains('bar').click().then(() => {
expect(clickFolderStub).to.have.been.calledWith()
})

cy.get('div').contains('map.spec.ts').click().then(() => {
expect(clickFileStub).to.have.been.calledWith({
type: 'file',
absolute: 'merp/map.spec.ts',
name: 'map.spec.ts',
})
})
})
})
Loading