This commit is contained in:
Philipp Kühn
2020-09-11 16:32:24 +02:00
23 changed files with 570 additions and 472 deletions

View File

@@ -6,6 +6,9 @@ jobs:
test: test:
runs-on: ubuntu-latest runs-on: ubuntu-latest
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
strategy: strategy:
matrix: matrix:
node-version: [14] node-version: [14]
@@ -20,6 +23,7 @@ jobs:
- uses: actions/checkout@v2.3.2 - uses: actions/checkout@v2.3.2
- name: Run tests with Cypress - name: Run tests with Cypress
id: cypress
uses: cypress-io/github-action@v2 uses: cypress-io/github-action@v2
with: with:
cache-key: node-v${{ matrix.node }}-on-${{ runner.os }}-hash-${{ hashFiles('yarn.lock') }} cache-key: node-v${{ matrix.node }}-on-${{ runner.os }}-hash-${{ hashFiles('yarn.lock') }}
@@ -42,9 +46,22 @@ jobs:
name: cypress-videos name: cypress-videos
path: tests/cypress/videos path: tests/cypress/videos
- name: Send Slack notifications
uses: act10ns/slack@v1
with:
status: ${{ job.status }}
steps: ${{ toJson(steps) }}
channel: '#tiptap-next'
if: failure()
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: test
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
strategy: strategy:
matrix: matrix:
node-version: [14] node-version: [14]
@@ -59,7 +76,17 @@ jobs:
- uses: actions/checkout@v2.3.2 - uses: actions/checkout@v2.3.2
- name: Install dependencies - name: Install dependencies
id: install-dependencies
run: yarn install run: yarn install
- name: Build packages dependencies - name: Build packages dependencies
id: build-packages
run: yarn build:packages run: yarn build:packages
- name: Send Slack notifications
uses: act10ns/slack@v1
with:
status: ${{ job.status }}
steps: ${{ toJson(steps) }}
channel: '#tiptap-next'
if: failure()

View File

@@ -1,14 +1,16 @@
context('/examples/basic', () => { context('/examples/basic', () => {
beforeEach(() => { before(() => {
cy.visit('/examples/basic') cy.visit('/examples/basic')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
editor.setContent('<p>foo</p>') editor.setContent('<p>foo</p>')
done()
}) })
}) })
describe('export', () => {
it('should return html', () => { it('should return html', () => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
@@ -39,9 +41,7 @@ context('/examples/basic', () => {
}) })
}) })
}) })
})
describe('insertText', () => {
it('should prepend', () => { it('should prepend', () => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
@@ -59,9 +59,7 @@ context('/examples/basic', () => {
cy.get('.ProseMirror p:first').should('contain', 'foobar') cy.get('.ProseMirror p:first').should('contain', 'foobar')
}) })
}) })
})
describe('insertHTML', () => {
it('should prepend', () => { it('should prepend', () => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
@@ -81,5 +79,4 @@ context('/examples/basic', () => {
cy.get('.ProseMirror p:last').should('contain', 'bar').should('not.contain', 'foo') cy.get('.ProseMirror p:last').should('contain', 'bar').should('not.contain', 'foo')
}) })
}) })
})
}) })

View File

@@ -3,7 +3,6 @@ context('/examples/export-html-or-json', () => {
cy.visit('/examples/export-html-or-json') cy.visit('/examples/export-html-or-json')
}) })
describe('export', () => {
it('should return json', () => { it('should return json', () => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
@@ -60,5 +59,4 @@ context('/examples/export-html-or-json', () => {
expect(html).to.equal('<p>You are able to export your data as <code>HTML</code> or <code>JSON</code>.</p>') expect(html).to.equal('<p>You are able to export your data as <code>HTML</code> or <code>JSON</code>.</p>')
}) })
}) })
})
}) })

View File

@@ -1,9 +1,8 @@
context('/examples/focus', () => { context('/examples/focus', () => {
beforeEach(() => { before(() => {
cy.visit('/examples/focus') cy.visit('/examples/focus')
}) })
describe('focus class', () => {
it('should have class', () => { it('should have class', () => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
@@ -12,5 +11,4 @@ context('/examples/focus', () => {
cy.get('.ProseMirror p:first').should('have.class', 'has-focus') cy.get('.ProseMirror p:first').should('have.class', 'has-focus')
}) })
}) })
})
}) })

View File

@@ -3,7 +3,6 @@ context('/examples/history', () => {
cy.visit('/examples/history') cy.visit('/examples/history')
}) })
describe('undo', () => {
it('should not have a mistake', () => { it('should not have a mistake', () => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
@@ -32,5 +31,4 @@ context('/examples/history', () => {
cy.get('.ProseMirror h2:first').should('not.contain', 'Mistake') cy.get('.ProseMirror h2:first').should('not.contain', 'Mistake')
}) })
}) })
})
}) })

View File

@@ -1,100 +1,91 @@
context('/examples/markdown-shortcuts', () => { context('/examples/markdown-shortcuts', () => {
beforeEach(() => { before(() => {
cy.visit('/examples/markdown-shortcuts') cy.visit('/examples/markdown-shortcuts')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
editor.clearContent() editor.clearContent()
done()
}) })
}) })
describe('headlines', () => {
it('should make a h1', () => { it('should make a h1', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('# Headline', {force: true}) .type('# Headline', { force: true })
.contains('h1', 'Headline') .contains('h1', 'Headline')
}) })
it('should make a h2', () => { it('should make a h2', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('## Headline', {force: true}) .type('## Headline', { force: true })
.contains('h2', 'Headline') .contains('h2', 'Headline')
}) })
it('should make a h3', () => { it('should make a h3', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('### Headline', {force: true}) .type('### Headline', { force: true })
.contains('h3', 'Headline') .contains('h3', 'Headline')
}) })
it('should make a h4', () => { it('should make a h4', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('#### Headline', {force: true}) .type('#### Headline', { force: true })
.contains('h4', 'Headline') .contains('h4', 'Headline')
}) })
it('should make a h5', () => { it('should make a h5', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('##### Headline', {force: true}) .type('##### Headline', { force: true })
.contains('h5', 'Headline') .contains('h5', 'Headline')
}) })
it('should make a h6', () => { it('should make a h6', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('###### Headline', {force: true}) .type('###### Headline', { force: true })
.contains('h6', 'Headline') .contains('h6', 'Headline')
}) })
})
describe('code', () => {
it('should create inline code', () => { it('should create inline code', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('`$foobar`', {force: true}) .type('`$foobar`', { force: true })
.contains('code', '$foobar') .contains('code', '$foobar')
}) })
})
describe('code block', () => {
it.skip('should create a code block without language', () => { it.skip('should create a code block without language', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('``` {enter}const foo = bar{enter}```', {force: true}) .type('``` {enter}const foo = bar{enter}```', { force: true })
.contains('pre', 'const foo = bar') .contains('pre', 'const foo = bar')
}) })
})
describe('bullet list', () => {
it.skip('should create a bullet list from asteriks', () => { it.skip('should create a bullet list from asteriks', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('* foobar', {force: true}) .type('* foobar', { force: true })
.contains('ul', 'foobar') .contains('ul', 'foobar')
}) })
it.skip('should create a bullet list from dashes', () => { it.skip('should create a bullet list from dashes', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('- foobar', {force: true}) .type('- foobar', { force: true })
.contains('ul', 'foobar') .contains('ul', 'foobar')
}) })
it.skip('should create a bullet list from pluses', () => { it.skip('should create a bullet list from pluses', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('+ foobar', {force: true}) .type('+ foobar', { force: true })
.contains('ul', 'foobar') .contains('ul', 'foobar')
}) })
})
describe('ordered list', () => {
it.skip('should create a ordered list', () => { it.skip('should create a ordered list', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('1. foobar', {force: true}) .type('1. foobar', { force: true })
.contains('ol', 'foobar') .contains('ol', 'foobar')
}) })
})
describe('blockquote', () => {
it.skip('should create a blockquote', () => { it.skip('should create a blockquote', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('> foobar', {force: true}) .type('> foobar', { force: true })
.contains('blockquote', 'foobar') .contains('blockquote', 'foobar')
}) })
})
}) })

View File

@@ -3,7 +3,6 @@ context('/examples/read-only', () => {
cy.visit('/examples/read-only') cy.visit('/examples/read-only')
}) })
describe('editable', () => {
it.skip('should be read-only', () => { it.skip('should be read-only', () => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
cy.get('#editable').uncheck() cy.get('#editable').uncheck()
@@ -25,5 +24,4 @@ context('/examples/read-only', () => {
cy.get('.ProseMirror p:first').should('contain', 'Edited: ') cy.get('.ProseMirror p:first').should('contain', 'Edited: ')
}) })
}) })
})
}) })

View File

@@ -1,5 +1,5 @@
context('/examples/simple', () => { context('/examples/simple', () => {
beforeEach(() => { before(() => {
cy.visit('/examples/simple') cy.visit('/examples/simple')
}) })
}) })

View File

@@ -1,48 +1,51 @@
context('/api/extensions/blockquote', () => { context('/api/extensions/blockquote', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/blockquote') cy.visit('/api/extensions/blockquote')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
editor.setContent('<p>Example Text</p>') editor.setContent('<p>Example Text</p>')
editor.focus().selectAll() editor.selectAll()
done()
}) })
}) })
describe('blockquote', () => {
it('the button should make the selected line a blockquote', () => { it('the button should make the selected line a blockquote', () => {
cy.get('.ProseMirror blockquote').should('not.exist')
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('blockquote', 'Example Text') cy.get('.ProseMirror').contains('blockquote', 'Example Text')
}) })
it('the button should toggle the blockquote', () => { it('the button should toggle the blockquote', () => {
cy.get('.ProseMirror blockquote').should('not.exist')
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('blockquote', 'Example Text') cy.get('.ProseMirror').contains('blockquote', 'Example Text')
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror blockquote').should('not.exist') cy.get('.ProseMirror blockquote').should('not.exist')
}) })
it('the keyboard shortcut should make the selected line a blockquote', () => { it('the keyboard shortcut should make the selected line a blockquote', () => {
cy.get('.ProseMirror').type('{meta}{shift}9', {force: true}) cy.get('.ProseMirror').type('{meta}{shift}9', { force: true })
cy.get('.ProseMirror').contains('blockquote', 'Example Text') cy.get('.ProseMirror').contains('blockquote', 'Example Text')
}) })
it('the keyboard shortcut should toggle the blockquote', () => { it('the keyboard shortcut should toggle the blockquote', () => {
cy.get('.ProseMirror').type('{meta}{shift}9', {force: true}) cy.get('.ProseMirror blockquote').should('not.exist')
cy.get('.ProseMirror').type('{meta}{shift}9', { force: true })
cy.get('.ProseMirror').contains('blockquote', 'Example Text') cy.get('.ProseMirror').contains('blockquote', 'Example Text')
cy.get('.ProseMirror').type('{meta}{shift}9', {force: true})
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.ProseMirror').type('{meta}{shift}9', { force: true })
cy.get('.ProseMirror blockquote').should('not.exist') cy.get('.ProseMirror blockquote').should('not.exist')
}) })
it('should make a blockquote from markdown shortcuts', () => { it('should make a blockquote from markdown shortcuts', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.clearContent()
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('> Quote', {force: true}) .type('> Quote', { force: true })
.contains('blockquote', 'Quote') .contains('blockquote', 'Quote')
}) })
})
})
}) })

View File

@@ -1,45 +1,54 @@
context('/api/extensions/bold', () => { context('/api/extensions/bold', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/bold') cy.visit('/api/extensions/bold')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
editor.setContent('<p>Example Text</p>') editor.setContent('<p>Example Text</p>')
editor.focus().selectAll() editor.selectAll()
done()
}) })
}) })
describe('bold', () => {
it('the button should make the selected text bold', () => { it('the button should make the selected text bold', () => {
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('strong', 'Example Text') cy.get('.ProseMirror').contains('strong', 'Example Text')
}) })
it('the button should toggle the selected text bold', () => { it('the button should toggle the selected text bold', () => {
cy.get('.demo__preview button:first').dblclick({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror strong').should('not.exist') cy.get('.ProseMirror strong').should('not.exist')
}) })
it('the keyboard shortcut should make the selected text bold', () => { it('the keyboard shortcut should make the selected text bold', () => {
cy.get('.ProseMirror').type('{meta}b', {force: true}) cy.get('.ProseMirror')
cy.get('.ProseMirror').contains('strong', 'Example Text') .type('{meta}b', { force: true })
.contains('strong', 'Example Text')
}) })
it('the keyboard shortcut should toggle the selected text bold', () => { it('the keyboard shortcut should toggle the selected text bold', () => {
cy.get('.ProseMirror').type('{meta}b', {force: true}).type('{meta}b', {force: true}) cy.get('.ProseMirror')
cy.get('.ProseMirror strong').should('not.exist') .type('{meta}b', { force: true })
.contains('strong', 'Example Text')
cy.get('.ProseMirror')
.type('{meta}b', { force: true })
.should('not.exist')
}) })
it('should make a bold text from the default markdown shortcut', () => { it('should make a bold text from the default markdown shortcut', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('**Bold**', {force: true}) .type('**Bold**', { force: true })
.contains('strong', 'Bold') .contains('strong', 'Bold')
}) })
it('should make a bold text from the alternative markdown shortcut', () => { it('should make a bold text from the alternative markdown shortcut', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('__Bold__', {force: true}) .type('__Bold__', { force: true })
.contains('strong', 'Bold') .contains('strong', 'Bold')
}) })
})
}) })

View File

@@ -1,23 +1,26 @@
context('/api/extensions/code', () => { context('/api/extensions/code', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/code') cy.visit('/api/extensions/code')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
editor.setContent('<p>Example Text</p>') editor.setContent('<p>Example Text</p>')
editor.focus().selectAll() editor.selectAll()
done()
}) })
}) })
describe('code', () => {
it('should mark the selected text as inline code', () => { it('should mark the selected text as inline code', () => {
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('code', 'Example Text') cy.get('.ProseMirror').contains('code', 'Example Text')
}) })
it('should toggle the selected text as inline code', () => { it('should toggle the selected text as inline code', () => {
cy.get('.demo__preview button:first').dblclick({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror code').should('not.exist') cy.get('.ProseMirror code').should('not.exist')
}) })
})
}) })

View File

@@ -1,15 +1,17 @@
context('/api/extensions/code-block', () => { context('/api/extensions/code-block', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/code-block') cy.visit('/api/extensions/code-block')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
editor.setContent('<p>Example Text</p>') editor.setContent('<p>Example Text</p>')
editor.focus().selectAll() editor.selectAll()
done()
}) })
}) })
describe('code-block', () => {
it('the button should make the selected line a code block', () => { it('the button should make the selected line a code block', () => {
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('pre', 'Example Text') cy.get('.ProseMirror').contains('pre', 'Example Text')
@@ -18,31 +20,29 @@ context('/api/extensions/code-block', () => {
it('the button should toggle the code block', () => { it('the button should toggle the code block', () => {
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('pre', 'Example Text') cy.get('.ProseMirror').contains('pre', 'Example Text')
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror pre').should('not.exist') cy.get('.ProseMirror pre').should('not.exist')
}) })
it('the keyboard shortcut should make the selected line a code block', () => { it('the keyboard shortcut should make the selected line a code block', () => {
cy.get('.ProseMirror').type('{control}{shift}\\', {force: true}) cy.get('.ProseMirror').type('{control}{shift}\\', { force: true })
cy.get('.ProseMirror').contains('pre', 'Example Text') cy.get('.ProseMirror').contains('pre', 'Example Text')
}) })
it('the keyboard shortcut should toggle the code block', () => { it('the keyboard shortcut should toggle the code block', () => {
cy.get('.ProseMirror').type('{control}{shift}\\', {force: true}) cy.get('.ProseMirror').type('{control}{shift}\\', { force: true })
cy.get('.ProseMirror').contains('pre', 'Example Text') cy.get('.ProseMirror').contains('pre', 'Example Text')
cy.get('.ProseMirror').type('{control}{shift}\\', {force: true})
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.ProseMirror').type('{control}{shift}\\', { force: true })
cy.get('.ProseMirror pre').should('not.exist') cy.get('.ProseMirror pre').should('not.exist')
}) })
it('should make a code block from markdown shortcuts', () => { it('should make a code block from markdown shortcuts', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.clearContent()
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('``` {enter}Code', {force: true}) .type('``` {enter}Code', { force: true })
.contains('pre', 'Code') .contains('pre', 'Code')
}) })
})
})
}) })

View File

@@ -1,5 +1,5 @@
context('/api/extensions/document', () => { context('/api/extensions/document', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/document') cy.visit('/api/extensions/document')
}) })
}) })

View File

@@ -1,14 +1,15 @@
context('/api/extensions/hard-break', () => { context('/api/extensions/hard-break', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/hard-break') cy.visit('/api/extensions/hard-break')
})
beforeEach(() => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
editor.setContent('<p>Example Text</p>') editor.setContent('<p>Example Text</p>')
}) })
}) })
describe('hard-break', () => {
it('the button should add a line break', () => { it('the button should add a line break', () => {
cy.get('.ProseMirror br').should('not.exist') cy.get('.ProseMirror br').should('not.exist')
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
@@ -17,14 +18,13 @@ context('/api/extensions/hard-break', () => {
it('the default keyboard shortcut should add a line break', () => { it('the default keyboard shortcut should add a line break', () => {
cy.get('.ProseMirror br').should('not.exist') cy.get('.ProseMirror br').should('not.exist')
cy.get('.ProseMirror').type('{shift}{enter}', {force: true}) cy.get('.ProseMirror').type('{shift}{enter}', { force: true })
cy.get('.ProseMirror br').should('exist') cy.get('.ProseMirror br').should('exist')
}) })
it('the alternative keyboard shortcut should add a line break', () => { it('the alternative keyboard shortcut should add a line break', () => {
cy.get('.ProseMirror br').should('not.exist') cy.get('.ProseMirror br').should('not.exist')
cy.get('.ProseMirror').type('{meta}{enter}', {force: true}) cy.get('.ProseMirror').type('{meta}{enter}', { force: true })
cy.get('.ProseMirror br').should('exist') cy.get('.ProseMirror br').should('exist')
}) })
})
}) })

View File

@@ -1,5 +1,32 @@
context('/api/extensions/heading', () => { context('/api/extensions/heading', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/heading') cy.visit('/api/extensions/heading')
}) })
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>Example Text</p>')
editor.selectAll()
done()
})
})
it('the button should make the selected line a h1', () => {
cy.get('.ProseMirror h1').should('not.exist')
cy.get('.demo__preview button:nth-child(1)').click({ force: true })
cy.get('.ProseMirror').contains('h1', 'Example Text')
})
it('the button should make the selected line a h2', () => {
cy.get('.ProseMirror h2').should('not.exist')
cy.get('.demo__preview button:nth-child(2)').click({ force: true })
cy.get('.ProseMirror').contains('h2', 'Example Text')
})
it('the button should make the selected line a h3', () => {
cy.get('.ProseMirror h3').should('not.exist')
cy.get('.demo__preview button:nth-child(3)').click({ force: true })
cy.get('.ProseMirror').contains('h3', 'Example Text')
})
}) })

View File

@@ -1,14 +1,15 @@
context('/api/extensions/history', () => { context('/api/extensions/history', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/history') cy.visit('/api/extensions/history')
})
beforeEach(() => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
editor.setContent('<p>Mistake</p>') editor.setContent('<p>Mistake</p>')
}) })
}) })
describe('undo', () => {
it('should make the last change undone', () => { it('should make the last change undone', () => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
cy.get('.ProseMirror').should('contain', 'Mistake') cy.get('.ProseMirror').should('contain', 'Mistake')
@@ -19,12 +20,10 @@ context('/api/extensions/history', () => {
}) })
it('the keyboard shortcut should make the last change undone', () => { it('the keyboard shortcut should make the last change undone', () => {
cy.get('.ProseMirror').type('{meta}z', {force: true}) cy.get('.ProseMirror').type('{meta}z', { force: true })
cy.get('.ProseMirror').should('not.contain', 'Mistake') cy.get('.ProseMirror').should('not.contain', 'Mistake')
}) })
})
describe('redo', () => {
it('should apply the last undone change again', () => { it('should apply the last undone change again', () => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
cy.get('.ProseMirror').should('contain', 'Mistake') cy.get('.ProseMirror').should('contain', 'Mistake')
@@ -37,11 +36,10 @@ context('/api/extensions/history', () => {
}) })
it.skip('the keyboard shortcut should apply the last undone change again', () => { it.skip('the keyboard shortcut should apply the last undone change again', () => {
cy.get('.ProseMirror').type('{meta}z', {force: true}) cy.get('.ProseMirror').type('{meta}z', { force: true })
cy.get('.ProseMirror').should('not.contain', 'Mistake') cy.get('.ProseMirror').should('not.contain', 'Mistake')
cy.get('.ProseMirror').type('{meta}{shift}z', {force: true}) cy.get('.ProseMirror').type('{meta}{shift}z', { force: true })
cy.get('.ProseMirror').should('contain', 'Mistake') cy.get('.ProseMirror').should('contain', 'Mistake')
}) })
})
}) })

View File

@@ -1,14 +1,15 @@
context('/api/extensions/horizontal-rule', () => { context('/api/extensions/horizontal-rule', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/horizontal-rule') cy.visit('/api/extensions/horizontal-rule')
})
beforeEach(() => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
editor.setContent('<p>Example Text</p>') editor.setContent('<p>Example Text</p>')
}) })
}) })
describe('horizontal-rule', () => {
it('the button should add a horizontal rule', () => { it('the button should add a horizontal rule', () => {
cy.get('.ProseMirror hr').should('not.exist') cy.get('.ProseMirror hr').should('not.exist')
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
@@ -21,7 +22,7 @@ context('/api/extensions/horizontal-rule', () => {
editor.clearContent() editor.clearContent()
cy.get('.ProseMirror hr').should('not.exist') cy.get('.ProseMirror hr').should('not.exist')
cy.get('.ProseMirror').type('---', {force: true}) cy.get('.ProseMirror').type('---', { force: true })
cy.get('.ProseMirror hr').should('exist') cy.get('.ProseMirror hr').should('exist')
}) })
}) })
@@ -32,9 +33,8 @@ context('/api/extensions/horizontal-rule', () => {
editor.clearContent() editor.clearContent()
cy.get('.ProseMirror hr').should('not.exist') cy.get('.ProseMirror hr').should('not.exist')
cy.get('.ProseMirror').type('___ ', {force: true}) cy.get('.ProseMirror').type('___ ', { force: true })
cy.get('.ProseMirror hr').should('exist') cy.get('.ProseMirror hr').should('exist')
}) })
}) })
})
}) })

View File

@@ -1,33 +1,36 @@
context('/api/extensions/italic', () => { context('/api/extensions/italic', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/italic') cy.visit('/api/extensions/italic')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
editor.setContent('<p>Example Text</p>') editor.setContent('<p>Example Text</p>')
editor.focus().selectAll() editor.selectAll()
done()
}) })
}) })
describe('italic', () => {
it('the button should make the selected text italic', () => { it('the button should make the selected text italic', () => {
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('em', 'Example Text') cy.get('.ProseMirror').contains('em', 'Example Text')
}) })
it('the button should toggle the selected text italic', () => { it('the button should toggle the selected text italic', () => {
cy.get('.demo__preview button:first').dblclick({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror em').should('not.exist') cy.get('.ProseMirror em').should('not.exist')
}) })
it('the keyboard shortcut should make the selected text italic', () => { it('the keyboard shortcut should make the selected text italic', () => {
cy.get('.ProseMirror').type('{meta}i', {force: true}) cy.get('.ProseMirror').type('{meta}i', { force: true })
cy.get('.ProseMirror').contains('em', 'Example Text') cy.get('.ProseMirror').contains('em', 'Example Text')
}) })
it('the keyboard shortcut should toggle the selected text italic', () => { it('the keyboard shortcut should toggle the selected text italic', () => {
cy.get('.ProseMirror').type('{meta}i', {force: true}).type('{meta}i', {force: true}) cy.get('.ProseMirror').type('{meta}i', { force: true }).type('{meta}i', { force: true })
cy.get('.ProseMirror em').should('not.exist') cy.get('.ProseMirror em').should('not.exist')
}) })
})
}) })

View File

@@ -1,5 +1,33 @@
context('/api/extensions/paragraph', () => { context('/api/extensions/paragraph', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/paragraph') cy.visit('/api/extensions/paragraph')
}) })
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.clearContent()
done()
})
})
it('text should be wrapped in a paragraph by default', () => {
cy.get('.ProseMirror').type('Example Text', { force: true })
cy.get('.ProseMirror').contains('p', 'Example Text')
cy.get('.ProseMirror').find('p').should('have.length', 1)
})
it('enter should make a new paragraph', () => {
cy.get('.ProseMirror').type('First Paragraph{enter}Second Paragraph', { force: true })
cy.get('.ProseMirror').find('p').should('have.length', 2)
cy.get('.ProseMirror').contains('p:first', 'First Paragraph')
cy.get('.ProseMirror').contains('p:nth-child(2)', 'Second Paragraph')
})
it('backspace should remove the second paragraph', () => {
cy.get('.ProseMirror').type('{enter}', { force: true })
cy.get('.ProseMirror').find('p').should('have.length', 2)
cy.get('.ProseMirror').type('{backspace}', { force: true })
cy.get('.ProseMirror').find('p').should('have.length', 1)
})
}) })

View File

@@ -1,39 +1,42 @@
context('/api/extensions/strike', () => { context('/api/extensions/strike', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/strike') cy.visit('/api/extensions/strike')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
editor.setContent('<p>Example Text</p>') editor.setContent('<p>Example Text</p>')
editor.focus().selectAll() editor.selectAll()
done()
}) })
}) })
describe('strike', () => {
it('the button should strike the selected text', () => { it('the button should strike the selected text', () => {
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('s', 'Example Text') cy.get('.ProseMirror').contains('s', 'Example Text')
}) })
it('the button should toggle the selected text striked', () => { it('the button should toggle the selected text striked', () => {
cy.get('.demo__preview button:first').dblclick({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror s').should('not.exist') cy.get('.ProseMirror s').should('not.exist')
}) })
it('the keyboard shortcut should strike the selected text', () => { it('the keyboard shortcut should strike the selected text', () => {
cy.get('.ProseMirror').type('{meta}d', {force: true}) cy.get('.ProseMirror').type('{meta}d', { force: true })
cy.get('.ProseMirror').contains('s', 'Example Text') cy.get('.ProseMirror').contains('s', 'Example Text')
}) })
it('the keyboard shortcut should toggle the selected text striked', () => { it('the keyboard shortcut should toggle the selected text striked', () => {
cy.get('.ProseMirror').type('{meta}d', {force: true}).type('{meta}d', {force: true}) cy.get('.ProseMirror').type('{meta}d', { force: true }).type('{meta}d', { force: true })
cy.get('.ProseMirror s').should('not.exist') cy.get('.ProseMirror s').should('not.exist')
}) })
it('should make a striked text from the markdown shortcut', () => { it('should make a striked text from the markdown shortcut', () => {
cy.get('.ProseMirror') cy.get('.ProseMirror')
.type('~Strike~', {force: true}) .type('~Strike~', { force: true })
.contains('s', 'Strike') .contains('s', 'Strike')
}) })
})
}) })

View File

@@ -1,33 +1,36 @@
context('/api/extensions/underline', () => { context('/api/extensions/underline', () => {
beforeEach(() => { before(() => {
cy.visit('/api/extensions/underline') cy.visit('/api/extensions/underline')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => { cy.get('.ProseMirror').window().then(window => {
const { editor } = window const { editor } = window
editor.setContent('<p>Example Text</p>') editor.setContent('<p>Example Text</p>')
editor.focus().selectAll() editor.selectAll()
done()
}) })
}) })
describe('bold', () => {
it('the button should underline the selected text', () => { it('the button should underline the selected text', () => {
cy.get('.demo__preview button:first').click({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('u', 'Example Text') cy.get('.ProseMirror').contains('u', 'Example Text')
}) })
it('the button should toggle the selected text underline', () => { it('the button should toggle the selected text underline', () => {
cy.get('.demo__preview button:first').dblclick({ force: true }) cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror u').should('not.exist') cy.get('.ProseMirror u').should('not.exist')
}) })
it('the keyboard shortcut should underline the selected text', () => { it('the keyboard shortcut should underline the selected text', () => {
cy.get('.ProseMirror').type('{meta}u', {force: true}) cy.get('.ProseMirror').type('{meta}u', { force: true })
cy.get('.ProseMirror').contains('u', 'Example Text') cy.get('.ProseMirror').contains('u', 'Example Text')
}) })
it('the keyboard shortcut should toggle the selected text underline', () => { it('the keyboard shortcut should toggle the selected text underline', () => {
cy.get('.ProseMirror').type('{meta}u', {force: true}).type('{meta}u', {force: true}) cy.get('.ProseMirror').type('{meta}u', { force: true }).type('{meta}u', { force: true })
cy.get('.ProseMirror u').should('not.exist') cy.get('.ProseMirror u').should('not.exist')
}) })
})
}) })

View File

@@ -195,3 +195,15 @@
link: /api/schema/get-schema link: /api/schema/get-schema
- title: generateHtml - title: generateHtml
link: /api/schema/generate-html link: /api/schema/generate-html
- title: Best Practices
items:
- title: Overview
link: /best-practices/overview/
draft: true
- title: Menus
link: /best-practices/menus/
draft: true
- title: Keyboard Shortcuts
link: /best-practices/keyboard-shortcuts/
draft: true

View File

@@ -1,5 +1,7 @@
{ {
"baseUrl": "http://localhost:3000", "baseUrl": "http://localhost:3000",
"integrationFolder": "../docs/src/", "integrationFolder": "../docs/src/",
"testFiles": "**/*.spec.js" "testFiles": "**/*.spec.js",
"viewportWidth": 1280,
"viewportHeight": 1280
} }