From 1bc9edc53ae3d30c3274fddf88deb76585dacffb Mon Sep 17 00:00:00 2001 From: Carsten Klein Date: Fri, 29 Mar 2019 19:59:11 +0100 Subject: [PATCH] initial version of site using custom theme --- .gitignore | 3 + 404.html | 10 ++ Gemfile | 26 +++ Gemfile.lock | 250 ++++++++++++++++++++++++++++ README.md | 3 +- _config.yml | 38 +++++ _includes/example-code.md | 12 ++ index.md | 43 +++++ pages/contributing/CONTRIBUTING.md | 61 +++++++ pages/contributing/barfoo.md | 13 ++ pages/contributing/foobar.md | 13 ++ pages/contributing/index.md | 12 ++ pages/contributing/pull_requests.md | 6 + pages/guide/barfoo.md | 13 ++ pages/guide/index.md | 14 ++ pages/guide/setup.md | 44 +++++ pages/reference/barfoo.md | 13 ++ pages/reference/foobar.md | 13 ++ pages/reference/index.md | 12 ++ pages/support/barfoo.md | 13 ++ pages/support/foobar.md | 13 ++ pages/support/index.md | 12 ++ script/bootstrap | 7 + script/serve | 3 + 24 files changed, 645 insertions(+), 2 deletions(-) create mode 100644 404.html create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 _config.yml create mode 100644 _includes/example-code.md create mode 100644 index.md create mode 100644 pages/contributing/CONTRIBUTING.md create mode 100644 pages/contributing/barfoo.md create mode 100644 pages/contributing/foobar.md create mode 100644 pages/contributing/index.md create mode 100644 pages/contributing/pull_requests.md create mode 100644 pages/guide/barfoo.md create mode 100644 pages/guide/index.md create mode 100644 pages/guide/setup.md create mode 100644 pages/reference/barfoo.md create mode 100644 pages/reference/foobar.md create mode 100644 pages/reference/index.md create mode 100644 pages/support/barfoo.md create mode 100644 pages/support/foobar.md create mode 100644 pages/support/index.md create mode 100755 script/bootstrap create mode 100755 script/serve diff --git a/.gitignore b/.gitignore index badbc02..6475aca 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,5 @@ _site .sass-cache +.jekyll-metadata +package-lock.json +attic diff --git a/404.html b/404.html new file mode 100644 index 0000000..576b9b0 --- /dev/null +++ b/404.html @@ -0,0 +1,10 @@ +--- +layout: error +--- + +

404

+
+

Page not found

+

The requested page could not be found.

+
+ diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..6a04724 --- /dev/null +++ b/Gemfile @@ -0,0 +1,26 @@ +source "https://rubygems.org" + +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# This will help ensure the proper Jekyll version is running. +# Happy Jekylling! + +# If you want to use GitHub Pages, remove the "gem "jekyll"". +# To upgrade, run `bundle update github-pages`. +gem "github-pages", group: :jekyll_plugins + +# If you have any plugins, put them here! +group :jekyll_plugins do + gem "jekyll-remote-theme" +end + +# Windows does not include zoneinfo files, so bundle the tzinfo-data gem +gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby] + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.0" if Gem.win_platform? + diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..51a0a63 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,250 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (4.2.10) + i18n (~> 0.7) + minitest (~> 5.1) + thread_safe (~> 0.3, >= 0.3.4) + tzinfo (~> 1.1) + addressable (2.5.2) + public_suffix (>= 2.0.2, < 4.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) + colorator (1.1.0) + commonmarker (0.17.13) + ruby-enum (~> 0.5) + concurrent-ruby (1.1.5) + dnsruby (1.61.2) + addressable (~> 2.5) + em-websocket (0.5.1) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) + ethon (0.12.0) + ffi (>= 1.3.0) + eventmachine (1.2.7) + execjs (2.7.0) + faraday (0.15.4) + multipart-post (>= 1.2, < 3) + ffi (1.10.0) + forwardable-extended (2.6.0) + gemoji (3.0.0) + github-pages (197) + activesupport (= 4.2.10) + github-pages-health-check (= 1.16.1) + jekyll (= 3.7.4) + jekyll-avatar (= 0.6.0) + jekyll-coffeescript (= 1.1.1) + jekyll-commonmark-ghpages (= 0.1.5) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.11.0) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.12.1) + jekyll-mentions (= 1.4.1) + jekyll-optional-front-matter (= 0.3.0) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.2.0) + jekyll-redirect-from (= 0.14.0) + jekyll-relative-links (= 0.6.0) + jekyll-remote-theme (= 0.3.1) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.5.0) + jekyll-sitemap (= 1.2.0) + jekyll-swiss (= 0.4.0) + jekyll-theme-architect (= 0.1.1) + jekyll-theme-cayman (= 0.1.1) + jekyll-theme-dinky (= 0.1.1) + jekyll-theme-hacker (= 0.1.1) + jekyll-theme-leap-day (= 0.1.1) + jekyll-theme-merlot (= 0.1.1) + jekyll-theme-midnight (= 0.1.1) + jekyll-theme-minimal (= 0.1.1) + jekyll-theme-modernist (= 0.1.1) + jekyll-theme-primer (= 0.5.3) + jekyll-theme-slate (= 0.1.1) + jekyll-theme-tactile (= 0.1.1) + jekyll-theme-time-machine (= 0.1.1) + jekyll-titles-from-headings (= 0.5.1) + jemoji (= 0.10.2) + kramdown (= 1.17.0) + liquid (= 4.0.0) + listen (= 3.1.5) + mercenary (~> 0.3) + minima (= 2.5.0) + nokogiri (>= 1.8.5, < 2.0) + rouge (= 2.2.1) + terminal-table (~> 1.4) + github-pages-health-check (1.16.1) + addressable (~> 2.3) + dnsruby (~> 1.60) + octokit (~> 4.0) + public_suffix (~> 3.0) + typhoeus (~> 1.3) + html-pipeline (2.10.0) + activesupport (>= 2) + nokogiri (>= 1.4) + http_parser.rb (0.6.0) + i18n (0.9.5) + concurrent-ruby (~> 1.0) + jekyll (3.7.4) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 0.7) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 2.0) + kramdown (~> 1.14) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (>= 1.7, < 4) + safe_yaml (~> 1.0) + jekyll-avatar (0.6.0) + jekyll (~> 3.0) + jekyll-coffeescript (1.1.1) + coffee-script (~> 2.2) + coffee-script-source (~> 1.11.1) + jekyll-commonmark (1.3.1) + commonmarker (~> 0.14) + jekyll (>= 3.7, < 5.0) + jekyll-commonmark-ghpages (0.1.5) + commonmarker (~> 0.17.6) + jekyll-commonmark (~> 1) + rouge (~> 2) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.11.0) + jekyll (~> 3.3) + jekyll-gist (1.5.0) + octokit (~> 4.2) + jekyll-github-metadata (2.12.1) + jekyll (~> 3.4) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.4.1) + html-pipeline (~> 2.3) + jekyll (~> 3.0) + jekyll-optional-front-matter (0.3.0) + jekyll (~> 3.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.2.0) + jekyll (~> 3.0) + jekyll-redirect-from (0.14.0) + jekyll (~> 3.3) + jekyll-relative-links (0.6.0) + jekyll (~> 3.3) + jekyll-remote-theme (0.3.1) + jekyll (~> 3.5) + rubyzip (>= 1.2.1, < 3.0) + jekyll-sass-converter (1.5.2) + sass (~> 3.4) + jekyll-seo-tag (2.5.0) + jekyll (~> 3.3) + jekyll-sitemap (1.2.0) + jekyll (~> 3.3) + jekyll-swiss (0.4.0) + jekyll-theme-architect (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-cayman (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-dinky (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-hacker (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-leap-day (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-merlot (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-midnight (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-minimal (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-modernist (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-primer (0.5.3) + jekyll (~> 3.5) + jekyll-github-metadata (~> 2.9) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-tactile (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-time-machine (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-titles-from-headings (0.5.1) + jekyll (~> 3.3) + jekyll-watch (2.2.1) + listen (~> 3.0) + jemoji (0.10.2) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (~> 3.0) + kramdown (1.17.0) + liquid (4.0.0) + listen (3.1.5) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + ruby_dep (~> 1.2) + mercenary (0.3.6) + mini_portile2 (2.4.0) + minima (2.5.0) + jekyll (~> 3.5) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + minitest (5.11.3) + multipart-post (2.0.0) + nokogiri (1.10.2) + mini_portile2 (~> 2.4.0) + octokit (4.13.0) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (3.0.3) + rb-fsevent (0.10.3) + rb-inotify (0.10.0) + ffi (~> 1.0) + rouge (2.2.1) + ruby-enum (0.7.2) + i18n + ruby_dep (1.5.0) + rubyzip (1.2.2) + safe_yaml (1.0.5) + sass (3.7.3) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sawyer (0.8.1) + addressable (>= 2.3.5, < 2.6) + faraday (~> 0.8, < 1.0) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) + typhoeus (1.3.1) + ethon (>= 0.9.0) + tzinfo (1.2.5) + thread_safe (~> 0.1) + unicode-display_width (1.5.0) + +PLATFORMS + ruby + +DEPENDENCIES + github-pages + jekyll-remote-theme + tzinfo-data + +BUNDLED WITH + 2.0.1 diff --git a/README.md b/README.md index 15f8a44..45d8305 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ # testdeck-site -WORK IN PROGRESS - +The testdeck site. diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..2062834 --- /dev/null +++ b/_config.yml @@ -0,0 +1,38 @@ +# For technical reasons, this file is *NOT* reloaded automatically when you use +# 'bundle exec jekyll serve'. If you change this file, please restart the server process. + +# +# global site settings +# +title: testdeck +email: testdeck2@gmail.com +description: >- # this means to ignore newlines until "baseurl:" + Write an awesome description for your new site here. You can edit this + line in _config.yml. It will appear in your document head meta (for + Google search results) and in your feed.xml site description. +baseurl: "" +url: "https://testdeck.org" + +# +# build settings +# +markdown: kramdown +remote_theme: testdeck/testdeck-jekyll-theme@gh-1 +plugins: + - jekyll-feed + - jekyll-remote-theme + +# +# excludes +# +exclude: + - README.md + - attic + +# +# google custom search engine +# +gcse: + id: 010650276315653629951:v3s_qe8occu + host: www.testdeck.org + diff --git a/_includes/example-code.md b/_includes/example-code.md new file mode 100644 index 0000000..8f1601a --- /dev/null +++ b/_includes/example-code.md @@ -0,0 +1,12 @@ +{% highlight TypeScript linenos %} +import { suite, test } from '@testdeck/mocha'; +import * as chai from 'chai'; + +@suite +class TestSuite { + @test + someTest() { + chai.assertTrue(false); + } +} +{% endhighlight %} diff --git a/index.md b/index.md new file mode 100644 index 0000000..bb5c319 --- /dev/null +++ b/index.md @@ -0,0 +1,43 @@ +--- +layout: frontpage +section: frontpage +role: index +label: Home +order: 0 +--- + +
+
+
+ +
+
+
{% include example-code.md %}
+
+
+
+ +
+
+
+ + + +
+
+
+
+ + + +
+
+
+
+ + + +
+
+
+ diff --git a/pages/contributing/CONTRIBUTING.md b/pages/contributing/CONTRIBUTING.md new file mode 100644 index 0000000..04d5194 --- /dev/null +++ b/pages/contributing/CONTRIBUTING.md @@ -0,0 +1,61 @@ +## Conding Style Guide +Run `npm test`, after the tests `tslint` will run. To run tslint alone use `npm run tslint`. There is also a `npm run tslint-fix` that will apply auto fixes for some issues, but this may also break stuff, make sure to commit your code before running autofixes. + +The project uses conventional changelog with angular style. +[Read more about messages here](https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/master/convention.md). + +## Bug Fixes +A bug fix: + - [ ] Has code fix + - [ ] Has unit tests, all tests pass + - [ ] Updates the README.md (If necessary) + +Commits are made using: `git commit`, and the commit text in vim follows the pattern: +``` +fix: fix async tests not detected + +Fix treating class methods with a `done` parameter as asynchronous tests. + +BREAKING CHANGE: Any existing synchronous tests, writen while using the previous (broken) version, that had 'accidently' a `done` parameter, will now be executed as asynchronous. +``` + +## New Features +A feature: + - [ ] Has the necessary fix + - [ ] Has unit tests, all tests pass + - [ ] Is described in the README.md + +Commits are made using `git commit`, and the commit text in vim follows the mattern: +``` +feat: static `before`/`after` methods run before/after the suite + +Add a support for static methods named `before` or `after` in a test class, to execute as if `before` or `after` mocha hooks. Providing a `done` argument or returning a promise will run these methods as asynchronos. `@timeout` and `@slow` can be applied on `before` or `after` methods. + +BREAKING CHANGE: Any existing static `before` or `after` methods in test class will now be executed as `before` or `after` hooks. As workaround - rename these methods. +``` + +## Other +### Refactor +Typos, reorganizing code that should not break anything etc. +``` +refactor: Move method A before method B +``` + +### +Updating README.md, version patch commits, etc. +``` +chore: bump version to 1.1.15 +``` + +## Maintainers +### Publishing +Publishing prerequisits: + - The `package.json` version must have been bumped. + - Tag the commit locally. For example `git tag v1.1.17`. The version must match exactly the version in the `package.json`. + - Run `npm run changelog` and edit by hand if necessary the `CHANGELOG.md`, commit, push. + - The commit to be published must have all green github CI builds. + - Run `git clean -xdf`, `git reset --hard`, `npm i`, `npm test` locally. + +When you have this in place: + - Publish `npm publish`. + - Push the tag to the origin. For example `git push origin v1.1.17`. diff --git a/pages/contributing/barfoo.md b/pages/contributing/barfoo.md new file mode 100644 index 0000000..5847014 --- /dev/null +++ b/pages/contributing/barfoo.md @@ -0,0 +1,13 @@ +--- +layout: contributing +section: contributing +role: page +order: 2 +title: Barfoo Contributing +label: Barfoo +description: | + Everything about contributing barfoo +--- + +This is the contributing/barfoo section + diff --git a/pages/contributing/foobar.md b/pages/contributing/foobar.md new file mode 100644 index 0000000..2af3537 --- /dev/null +++ b/pages/contributing/foobar.md @@ -0,0 +1,13 @@ +--- +layout: contributing +section: contributing +role: page +order: 1 +title: Foobar Contributing +label: Foobar +description: | + Everything about contributing foobar +--- + +This is the contributing/foobar section + diff --git a/pages/contributing/index.md b/pages/contributing/index.md new file mode 100644 index 0000000..edd4090 --- /dev/null +++ b/pages/contributing/index.md @@ -0,0 +1,12 @@ +--- +layout: contributing +section: contributing +role: index +order: 3 +label: Contributing +description: | + Everything about contributing +--- + +This is the contributing section + diff --git a/pages/contributing/pull_requests.md b/pages/contributing/pull_requests.md new file mode 100644 index 0000000..9428418 --- /dev/null +++ b/pages/contributing/pull_requests.md @@ -0,0 +1,6 @@ +--- +layout: contributing +--- + +Section about pull requests. + diff --git a/pages/guide/barfoo.md b/pages/guide/barfoo.md new file mode 100644 index 0000000..8140024 --- /dev/null +++ b/pages/guide/barfoo.md @@ -0,0 +1,13 @@ +--- +layout: guide +section: guide +role: page +order: 2 +title: Barfoo Guide +label: Barfoo +description: | + The barfoo guide +--- + +This is the guides/barfoo section + diff --git a/pages/guide/index.md b/pages/guide/index.md new file mode 100644 index 0000000..187e7a1 --- /dev/null +++ b/pages/guide/index.md @@ -0,0 +1,14 @@ +--- +layout: guide +section: guide +role: index +order: 1 +label: Guide +description: | + Testdeck guides +--- + +## Introduction + +In this section you will find guides that help you with getting started with Testdeck. + diff --git a/pages/guide/setup.md b/pages/guide/setup.md new file mode 100644 index 0000000..588597f --- /dev/null +++ b/pages/guide/setup.md @@ -0,0 +1,44 @@ +--- +layout: guide +section: guide +role: page +order: 1 +toc: true +title: Setting things up +label: Setup +description: | + Setting things up +--- + +## Setup + +First, you need to choose which test framework you are going to use. + +Testdeck supports Mocha, Jasmine and Jest. + +With some limitations, you can always change the test framework later on. (limitations: assertion/expectation framework.) + +### Mocha + +{% highlight shell %} +npm install @testdeck/mocha mocha @types/mocha +{% endhighlight %} + +Alternatively, you can clone the existing mocha-seed and start from there. + +### Jasmine + +{% highlight bash %} +npm install @testdeck/jasmine jasmine @types/jasmine +{% endhighlight %} + +Alternatively, you can clone the existing jasmine-seed and start from there. + +### Jest + +{% highlight bash %} +npm install @testdeck/jest jest @types/jest +{% endhighlight %} + +Alternatively, you can clone the existing jest-seed and start from there. + diff --git a/pages/reference/barfoo.md b/pages/reference/barfoo.md new file mode 100644 index 0000000..bc52ea5 --- /dev/null +++ b/pages/reference/barfoo.md @@ -0,0 +1,13 @@ +--- +layout: reference +section: reference +role: page +order: 2 +title: Barfoo Reference +label: Barfoo +description: | + The barfoo reference +--- + +This is the references/barfoo section + diff --git a/pages/reference/foobar.md b/pages/reference/foobar.md new file mode 100644 index 0000000..3497b13 --- /dev/null +++ b/pages/reference/foobar.md @@ -0,0 +1,13 @@ +--- +layout: reference +section: reference +role: page +order: 1 +title: Foobar Reference +label: Foobar +description: | + The foobar reference +--- + +This is the references/foobar section + diff --git a/pages/reference/index.md b/pages/reference/index.md new file mode 100644 index 0000000..4e49435 --- /dev/null +++ b/pages/reference/index.md @@ -0,0 +1,12 @@ +--- +layout: reference +section: reference +role: index +order: 2 +label: Reference +description: | + The reference +--- + +This is the references section + diff --git a/pages/support/barfoo.md b/pages/support/barfoo.md new file mode 100644 index 0000000..a5af418 --- /dev/null +++ b/pages/support/barfoo.md @@ -0,0 +1,13 @@ +--- +layout: support +section: support +role: page +order: 2 +title: Barfoo Support +label: Barfoo +description: | + The barfoo support +--- + +This is the support/barfoo section + diff --git a/pages/support/foobar.md b/pages/support/foobar.md new file mode 100644 index 0000000..119b6ea --- /dev/null +++ b/pages/support/foobar.md @@ -0,0 +1,13 @@ +--- +layout: support +section: support +role: page +order: 1 +title: Foobar Support +label: Foobar +description: | + The foobar support +--- + +This is the support/foobar section + diff --git a/pages/support/index.md b/pages/support/index.md new file mode 100644 index 0000000..2759c57 --- /dev/null +++ b/pages/support/index.md @@ -0,0 +1,12 @@ +--- +layout: support +section: support +role: index +order: 4 +label: Support +description: | + The support +--- + +This is the support section + diff --git a/script/bootstrap b/script/bootstrap new file mode 100755 index 0000000..b382ecc --- /dev/null +++ b/script/bootstrap @@ -0,0 +1,7 @@ +#!/bin/sh + +set -e + +gem install bundler +bundle install +npm install diff --git a/script/serve b/script/serve new file mode 100755 index 0000000..d8c3e15 --- /dev/null +++ b/script/serve @@ -0,0 +1,3 @@ +#!/bin/sh + +bundle exec jekyll serve