├── .gitignore ├── .eslintrc ├── babel.config.js ├── test ├── index.test.js ├── about.test.js ├── block-cover.test.js ├── block-image.test.js ├── block-quotes.test.js ├── lorem-ipsum.test.js ├── support │ ├── test.hbs │ └── config.js ├── block-button.test.js ├── block-gallery.test.js ├── blocks-embeds.test.js ├── column-blocks.test.js ├── template-sticky.test.js ├── blocks-widgets.test.js ├── clearing-floats.test.js ├── edge-case-no-title.test.js ├── page-with-comments.test.js ├── post-format-chat.test.js ├── post-format-link.test.js ├── template-comments.test.js ├── template-more-tag.test.js ├── template-paginated.test.js ├── edge-case-many-tags.test.js ├── edge-case-no-content.test.js ├── post-format-aside.test.js ├── post-format-image.test.js ├── post-format-quote.test.js ├── post-format-status.test.js ├── block-category-common.test.js ├── blocks-formatting.test.js ├── media-twitter-embeds.test.js ├── page-image-alignment.test.js ├── post-format-gallery.test.js ├── post-format-standard.test.js ├── blocks-layout-elements.test.js ├── markup-image-alignment.test.js ├── markup-text-alignment.test.js ├── edge-case-many-categories.test.js ├── markup-title-with-markup.test.js ├── template-excerpt-defined.test.js ├── post-format-image-linked.test.js ├── post-format-video-youtube.test.js ├── template-comments-disabled.test.js ├── template-excerpt-generated.test.js ├── page-markup-and-formatting.test.js ├── page-with-comments-disabled.test.js ├── post-format-image-caption.test.js ├── template-password-protected.test.js ├── edge-case-nested-and-mixed-lists.test.js ├── markup-html-tags-and-formatting.test.js ├── template-featured-image-vertical.test.js ├── template-pingbacks-an-trackbacks.test.js ├── title-with-special-characters.test.js ├── template-featured-image-horizontal.test.js └── title-should-not-overflow-the-content-area.test.js ├── jest.config.js ├── .github └── workflows │ └── nodejs.yml ├── package.json ├── bin └── create-test-cases.js ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "extends": [ "plugin:@wordpress/eslint-plugin/recommended" ] 3 | } -------------------------------------------------------------------------------- /babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = function( api ) { 2 | api.cache( true ); 3 | 4 | return { 5 | presets: [ '@wordpress/babel-preset-default' ], 6 | }; 7 | }; 8 | -------------------------------------------------------------------------------- /test/index.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Page: Index', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/about.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Page: About', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=about` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/block-cover.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Cover Block', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=block-cover` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/block-image.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Image Block', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=block-image` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/block-quotes.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Quote Block', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=block-quotes` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/lorem-ipsum.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Page: Lorem Ipsum', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=lorem-ipsum` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/support/test.hbs: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( '{{ title }}', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?{{{ query }}}={{ slug }}` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/block-button.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Button Block', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=block-button` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/block-gallery.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Gallery Block', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=block-gallery` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/blocks-embeds.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Embed Blocks', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=blocks-embeds` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/column-blocks.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Columns Block', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=column-blocks` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/template-sticky.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Sticky', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=template-sticky` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/blocks-widgets.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Widget Blocks', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=blocks-widgets` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/clearing-floats.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Page: Clearing Floats', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=clearing-floats` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/edge-case-no-title.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: No Title', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=edge-case-no-title` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/page-with-comments.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Page: Comments', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=page-with-comments` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/post-format-chat.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Chat Format', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=post-format-chat` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/post-format-link.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Link Format', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=post-format-link` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/template-comments.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Comments', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=template-comments` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/template-more-tag.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: More Tag', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=template-more-tag` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/template-paginated.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Paginated', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=template-paginated` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/edge-case-many-tags.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Many Tags', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=edge-case-many-tags` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/edge-case-no-content.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: No Content', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=edge-case-no-content` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/post-format-aside.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Aside Format', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=post-format-aside` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/post-format-image.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Image Format', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=post-format-image` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/post-format-quote.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Quote Format', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=post-format-quote` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/post-format-status.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Status Format', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=post-format-status` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/support/config.js: -------------------------------------------------------------------------------- 1 | const WP_ADMIN_USER = { 2 | username: 'admin', 3 | password: 'password', 4 | }; 5 | 6 | const { 7 | WP_USERNAME = WP_ADMIN_USER.username, 8 | WP_PASSWORD = WP_ADMIN_USER.password, 9 | WP_BASE_URL = 'http://one.wordpress.test', 10 | } = process.env; 11 | 12 | module.exports = { 13 | WP_ADMIN_USER, 14 | WP_USERNAME, 15 | WP_PASSWORD, 16 | WP_BASE_URL, 17 | }; 18 | -------------------------------------------------------------------------------- /test/block-category-common.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Common Blocks', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=block-category-common` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/blocks-formatting.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Formatting Blocks', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=blocks-formatting` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/media-twitter-embeds.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Twitter Embeds', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=media-twitter-embeds` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/page-image-alignment.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Page: Image Alignment', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=page-image-alignment` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/post-format-gallery.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Gallery Format', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=post-format-gallery` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/post-format-standard.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Standard Format', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=post-format-standard` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/blocks-layout-elements.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Layout Blocks', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=blocks-layout-elements` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/markup-image-alignment.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Image Alignment', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=markup-image-alignment` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/markup-text-alignment.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Text Alignment', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=markup-text-alignment` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/edge-case-many-categories.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Many Categories', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=edge-case-many-categories` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/markup-title-with-markup.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Title With Markup', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=markup-title-with-markup` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/template-excerpt-defined.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Defined Excerpt', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=template-excerpt-defined` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/post-format-image-linked.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Linked Image Format', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=post-format-image-linked` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/post-format-video-youtube.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: YouTube Video Format', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=post-format-video-youtube` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/template-comments-disabled.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Comments Disabled', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=template-comments-disabled` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/template-excerpt-generated.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Generated Excerpt', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=template-excerpt-generated` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/page-markup-and-formatting.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Page: Markup and Formatting', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=page-markup-and-formatting` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/page-with-comments-disabled.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Page: Comments Disabled', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=page-with-comments-disabled` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/post-format-image-caption.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Captioned Image Format', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=post-format-image-caption` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/template-password-protected.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Password Protected', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=template-password-protected` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/edge-case-nested-and-mixed-lists.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Nested and Mixed Lists', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=edge-case-nested-and-mixed-lists` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/markup-html-tags-and-formatting.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: HTML Tags and Formatting', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=markup-html-tags-and-formatting` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/template-featured-image-vertical.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Vertical Featured Image', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=template-featured-image-vertical` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/template-pingbacks-an-trackbacks.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Pingbacks and Trackbacks', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=template-pingbacks-an-trackbacks` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/title-with-special-characters.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Title With Special Characters', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=title-with-special-characters` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/template-featured-image-horizontal.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Horizontal Featured Image', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=template-featured-image-horizontal` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /test/title-should-not-overflow-the-content-area.test.js: -------------------------------------------------------------------------------- 1 | /*global page */ 2 | 3 | const { WP_BASE_URL } = require( './support/config' ); 4 | 5 | describe( 'Post: Long Title', () => { 6 | beforeAll( async () => { 7 | await page.goto( `${ WP_BASE_URL }/?name=title-should-not-overflow-the-content-area` ); 8 | } ); 9 | 10 | it( 'Should pass Axe tests', async () => { 11 | await expect( page ).toPassAxeTests(); 12 | } ); 13 | } ); 14 | -------------------------------------------------------------------------------- /jest.config.js: -------------------------------------------------------------------------------- 1 | const jestE2EConfig = { 2 | preset: 'jest-puppeteer', 3 | setupFilesAfterEnv: [ 4 | '@wordpress/jest-puppeteer-axe', 5 | ], 6 | reporters: [ 7 | 'default', 8 | [ 9 | './node_modules/jest-html-reporter', { 10 | pageTitle: 'WP Theme Auditor Report', 11 | outputPath: 'test/report.html', 12 | }, 13 | ], 14 | ], 15 | testMatch: [ 16 | '**/test/*.test.js', 17 | ], 18 | }; 19 | 20 | module.exports = jestE2EConfig; 21 | -------------------------------------------------------------------------------- /.github/workflows/nodejs.yml: -------------------------------------------------------------------------------- 1 | name: Node CI 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build: 7 | 8 | runs-on: ubuntu-latest 9 | 10 | strategy: 11 | matrix: 12 | node-version: [8.x, 10.x, 12.x] 13 | 14 | steps: 15 | - uses: actions/checkout@v1 16 | - name: Use Node.js ${{ matrix.node-version }} 17 | uses: actions/setup-node@v1 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - name: npm install and test 21 | run: | 22 | npm install 23 | npm test 24 | env: 25 | CI: true 26 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "wp-theme-auditor", 3 | "version": "0.3.0", 4 | "description": "Accessibility auditing tools for WordPress themes.", 5 | "author": { 6 | "name": "Ned Zimmerman", 7 | "email": "ned@bight.ca", 8 | "url": "https://bight.ca" 9 | }, 10 | "license": "GPL-2.0-or-later", 11 | "keywords": [ 12 | "accessibility", 13 | "axe", 14 | "wordpress", 15 | "wp-theme-auditor" 16 | ], 17 | "homepage": "https://github.com/wpaccessibility/wp-theme-auditor#readme", 18 | "husky": { 19 | "hooks": { 20 | "pre-commit": "lint-staged" 21 | } 22 | }, 23 | "lint-staged": { 24 | "*.js": [ 25 | "npm run lint:js" 26 | ], 27 | "package.json": [ 28 | "npm run lint:pkg-json" 29 | ] 30 | }, 31 | "repository": { 32 | "type": "git", 33 | "url": "git+https://github.com/wpaccessibility/wp-theme-auditor.git" 34 | }, 35 | "bugs": { 36 | "url": "https://github.com/wpaccessibility/wp-theme-auditor/issues" 37 | }, 38 | "bin": { 39 | "create-test-cases": "./bin/create-test-cases.js" 40 | }, 41 | "dependencies": { 42 | "@wordpress/babel-preset-default": "^4.5.0", 43 | "@wordpress/e2e-test-utils": "^2.3.0", 44 | "@wordpress/e2e-tests": "^1.6.0", 45 | "@wordpress/jest-console": "^3.3.0", 46 | "@wordpress/jest-preset-default": "^5.1.0", 47 | "@wordpress/jest-puppeteer-axe": "^1.3.0", 48 | "@wordpress/scripts": "^4.1.0", 49 | "chalk": "^2.4.2", 50 | "core-js": "^3.2.1", 51 | "handlebars": "^4.3.3", 52 | "inquirer": "^7.0.0", 53 | "jest-html-reporter": "^2.6.2" 54 | }, 55 | "devDependencies": { 56 | "husky": "^3.0.9", 57 | "lint-staged": "^9.4.2" 58 | }, 59 | "scripts": { 60 | "lint:js": "wp-scripts lint-js .", 61 | "lint:pkg-json": "wp-scripts lint-pkg-json .", 62 | "test": "npm run -s lint:js && npm run -s lint:pkg-json" 63 | } 64 | } 65 | -------------------------------------------------------------------------------- /bin/create-test-cases.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | const chalk = require( 'chalk' ); 4 | const handlebars = require( 'handlebars' ); 5 | const inquirer = require( 'inquirer' ); 6 | const shell = require( 'shelljs' ); 7 | 8 | const init = () => { 9 | // eslint-disable-next-line no-console 10 | console.log( 11 | chalk.green.bold( 'Creating test cases...' ) 12 | ); 13 | }; 14 | 15 | const getTestCaseDetails = () => { 16 | const questions = [ 17 | { 18 | type: 'list', 19 | name: 'POSTTYPE', 20 | message: 'What is the post type?', 21 | choices: [ 'post', 'page' ], 22 | filter( val ) { 23 | return val.split( '.' )[ 1 ]; 24 | }, 25 | }, 26 | { 27 | name: 'SLUG', 28 | type: 'input', 29 | message: 'What is the slug of the post or page?', 30 | }, 31 | { 32 | name: 'TITLE', 33 | type: 'input', 34 | message: 'What is the title of the post or page?', 35 | }, 36 | ]; 37 | return inquirer.prompt( questions ); 38 | }; 39 | 40 | const doItAgain = () => { 41 | const question = [ 42 | { 43 | name: 'AGAIN', 44 | type: 'confirm', 45 | message: 'Create another test case?', 46 | }, 47 | ]; 48 | return inquirer.prompt( question ); 49 | }; 50 | 51 | const createFile = ( posttype, slug, title ) => { 52 | const query = ( posttype === 'page' ) ? 'pagename' : 'name'; 53 | const tpl = shell.cat( `${ process.cwd() }/test/support/test.hbs` ).toString(); 54 | const data = { 55 | title, 56 | query, 57 | slug, 58 | }; 59 | const template = handlebars.compile( tpl ); 60 | const filePath = `${ process.cwd() }/test/${ slug }.test.js`; 61 | new shell.ShellString( template( data ) ).to( filePath ); 62 | return filePath; 63 | }; 64 | 65 | const success = ( filepath ) => { 66 | // eslint-disable-next-line no-console 67 | console.log( 68 | chalk.green.bold( `Test case created at ${ filepath }.` ) 69 | ); 70 | }; 71 | 72 | const createTestCase = async () => { 73 | const answers = await getTestCaseDetails(); 74 | const { POSTTYPE, SLUG, TITLE } = answers; 75 | const filePath = createFile( POSTTYPE, SLUG, TITLE ); 76 | success( filePath ); 77 | const answer = await doItAgain(); 78 | const { AGAIN } = answer; 79 | if ( AGAIN ) { 80 | createTestCase(); 81 | } 82 | }; 83 | 84 | const run = async () => { 85 | init(); 86 | createTestCase(); 87 | }; 88 | 89 | run(); 90 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # wp-theme-auditor 2 | 3 | Accessibility auditing tools for WordPress themes. 4 | 5 | You can install this package to run [Axe](https://deque.com/axe) tests against your theme for automated accessibility feedback. 6 | 7 | ## Requirements 8 | 9 | - [npm](https://github.com/npm/cli/releases/latest) >= 6.8.0 10 | - A local WordPress install (>= 5.0) 11 | - A theme to test 12 | 13 | ## Installation 14 | 15 | Run the following command from your theme's root directory: 16 | 17 | ```bash 18 | npm init wp-theme-auditor 19 | ``` 20 | 21 | Then you'll need to add more test cases. You can do this interactively by running `npm run create-test-cases` from your theme's root directory. 22 | 23 | If, say, you wanted to test your theme's contact page which has a slug of `contact`, you might create a new test case with the following inputs: 24 | 25 | ```bash 26 | $ npm run create-test-cases 27 | > twentytwenty@1.0.0 create-test-cases /Users/ned/Sites/a11y/wp-content/themes/twentytwenty 28 | > create-test-cases 29 | 30 | Creating test cases... 31 | ? What is the post type? page 32 | ? What is the slug of the post or page? contact 33 | ? What is the title of the post or page? Contact page 34 | Test case created at /Users/ned/Sites/a11y/wp-content/themes/twentytwenty/test/contact.test.js. 35 | ``` 36 | 37 | The resulting test case file would contain the following content: 38 | 39 | ```javascript 40 | /*global page */ 41 | 42 | const { WP_BASE_URL } = require("./support/config"); 43 | 44 | describe("Contact page", () => { 45 | beforeAll(async () => { 46 | await page.goto(`${WP_BASE_URL}/?pagename=contact`); 47 | }); 48 | 49 | it("Should pass Axe tests", async () => { 50 | await expect(page).toPassAxeTests(); 51 | }); 52 | }); 53 | ``` 54 | 55 | ## Usage 56 | 57 | ```bash 58 | npm run test:axe 59 | ``` 60 | 61 | Tests will be run against [http://one.wordpress.test](https://varyingvagrantvagrants.org/docs/en-US/references/default-sites/) by default. If you'd like to run your tests against a different WordPress install, you can use the `WP_BASE_URL` environment variable: 62 | 63 | ```bash 64 | WP_BASE_URL=https://custom.test npm run test:axe 65 | ``` 66 | 67 | ## Contributors 68 | 69 | - [@aduth](https://github.com/aduth) 70 | - [@dylanb](https://github.com/dylanb) 71 | - [@greatislander](https://github.com/greatislander) 72 | - [@gziolo](https://github.com/gziolo) 73 | - [@joemcgill](https://github.com/joemcgill) 74 | - [@ryelle](https://github.com/ryelle) 75 | - [@stephenmathieson](https://github.com/stephenmathieson) 76 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------