chutney 3.7.0 → 3.8.1

data/usechutney.com/_config.yml

@@ -0,0 +1,298 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# 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.
+#
+# If you need help with YAML syntax, here are some quick references for you:
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+
+title: Chutney
+email: hello@billy-ruffian.co.uk
+description: >- # this means to ignore newlines until "baseurl:"
+  Beautiful and tasteful best practice for Cucumber
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "https://www.usechutney.com" # the base hostname & protocol for your site, e.g. http://example.com
+twitter_username: thebillyruffian
+github_username: BillyRuffian
+
+include: ["pages", "docs"]
+
+# Build settings
+theme: minimal-mistakes-jekyll
+plugins:
+  - jekyll-feed
+  - jekyll-include-cache
+  - jekyll-paginate
+  - jekyll-sitemap
+  - jekyll-gist
+  - jekyll-data
+
+# Exclude from processing.
+# The following items will not be processed, by default.
+# Any item listed under the `exclude:` key here will be automatically added to
+# the internal "default list".
+#
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+#
+# exclude:
+#   - .sass-cache/
+#   - .jekyll-cache/
+#   - gemfiles/
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules/
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/
+
+minimal_mistakes_skin: "dirt" #"default" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"
+
+# Site Settings
+locale: "en-GB"
+rtl: # true, false (default) # turns direction of the page into right to left for RTL languages
+title_separator: "-"
+subtitle: "Best Practice for Cucumber" # site tagline that appears below site title in masthead
+name: "Nigel Brookes-Thomas"
+repository: # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes"
+teaser: # path of fallback teaser image, e.g. "/assets/images/500x300.png"
+logo: "/assets/images/mr_pickle.png" # path of logo image to display in the masthead, e.g. "/assets/images/88x88.png"
+masthead_title: # overrides the website title displayed in the masthead, use " " for no title
+breadcrumbs: # true, false (default)
+words_per_minute: 200
+enable_copy_code_button: true # true, false (default)
+copyright: # "copyright" name, defaults to site.title
+copyright_url: # "copyright" URL, defaults to site.url
+comments:
+  provider: # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "giscus", "custom"
+  disqus:
+    shortname: # https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname-
+  discourse:
+    server: # https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963 , e.g.: meta.discourse.org
+  facebook:
+    # https://developers.facebook.com/docs/plugins/comments
+    appid:
+    num_posts: # 5 (default)
+    colorscheme: # "light" (default), "dark"
+  utterances:
+    theme: # "github-light" (default), "github-dark"
+    issue_term: # "pathname" (default)
+  giscus:
+    repo_id: # Shown during giscus setup at https://giscus.app
+    category_name: # Full text name of the category
+    category_id: # Shown during giscus setup at https://giscus.app
+    discussion_term: # "pathname" (default), "url", "title", "og:title"
+    reactions_enabled: # '1' for enabled (default), '0' for disabled
+    theme: # "light" (default), "dark", "dark_dimmed", "transparent_dark", "preferred_color_scheme"
+    strict: # 1 for enabled, 0 for disabled (default)
+    input_position: # "top", "bottom" # The comment input box will be placed above or below the comments
+    emit_metadata: # 1 for enabled, 0 for disabled (default) # https://github.com/giscus/giscus/blob/main/ADVANCED-USAGE.md#imetadatamessage
+    lang: # "en" (default)
+    lazy: # true, false # Loading of the comments will be deferred until the user scrolls near the comments container.
+  staticman:
+    branch: # "master"
+    endpoint: # "https://{your Staticman v3 API}/v3/entry/github/"
+reCaptcha:
+  siteKey:
+  secret:
+atom_feed:
+  path: # blank (default) uses feed.xml
+  hide: true # true, false (default)
+search: true # true, false (default)
+search_full_content: true # true, false (default)
+search_provider: # lunr (default), algolia, google
+lunr:
+  search_within_pages: true # true, false (default)
+algolia:
+  application_id: # YOUR_APPLICATION_ID
+  index_name: # YOUR_INDEX_NAME
+  search_only_api_key: # YOUR_SEARCH_ONLY_API_KEY
+  powered_by: # true (default), false
+google:
+  search_engine_id: # YOUR_SEARCH_ENGINE_ID
+  instant_search: # false (default), true
+# SEO Related
+google_site_verification:
+bing_site_verification:
+naver_site_verification:
+yandex_site_verification:
+baidu_site_verification:
+
+# Site Author
+author:
+  name: "Nigel Brookes-Thomas (Billy Ruffian)"
+  avatar: "/assets/images/pug.png"
+  bio: "I test things and write ruby things."
+  location: "UK"
+  email:
+  links:
+    # - label: "Email"
+    #   icon: "fas fa-fw fa-envelope-square"
+    #   # url: "mailto:your.name@email.com"
+    - label: "Website"
+      icon: "fas fa-fw fa-link"
+      url: "https://www.billy-ruffian.co.uk"
+    # - label: "Twitter"
+    #   icon: "fab fa-fw fa-twitter-square"
+    #   # url: "https://twitter.com/"
+    # - label: "Facebook"
+    #   icon: "fab fa-fw fa-facebook-square"
+    #   # url: "https://facebook.com/"
+    - label: "GitHub"
+      icon: "fab fa-fw fa-github"
+      url: "https://github.com/BillyRuffian"
+    # - label: "Instagram"
+    #   icon: "fab fa-fw fa-instagram"
+    # url: "https://instagram.com/"
+
+# Site Footer
+# footer:
+#   links:
+#     - label: "Twitter"
+#       icon: "fab fa-fw fa-twitter-square"
+#       # url:
+#     - label: "Facebook"
+#       icon: "fab fa-fw fa-facebook-square"
+#       # url:
+#     - label: "GitHub"
+#       icon: "fab fa-fw fa-github"
+#       # url:
+#     - label: "GitLab"
+#       icon: "fab fa-fw fa-gitlab"
+#       # url:
+#     - label: "Bitbucket"
+#       icon: "fab fa-fw fa-bitbucket"
+#       # url:
+#     - label: "Instagram"
+#       icon: "fab fa-fw fa-instagram"
+#       # url:
+
+# Conversion
+markdown: kramdown
+highlighter: rouge
+lsi: false
+excerpt_separator: "\n\n"
+incremental: false
+
+# Markdown Processing
+kramdown:
+  input: GFM
+  hard_wrap: false
+  auto_ids: true
+  footnote_nr: 1
+  entity_output: as_char
+  toc_levels: 1..6
+  smart_quotes: lsquo,rsquo,ldquo,rdquo
+  enable_coderay: false
+
+# Sass/SCSS
+sass:
+  sass_dir: _sass
+  style: compressed # https://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style
+
+# Outputting
+permalink: /:categories/:title/
+timezone: # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+
+# Pagination with jekyll-paginate
+paginate: 5 # amount of posts to show
+paginate_path: /page:num/
+
+# Pagination with jekyll-paginate-v2
+# See https://github.com/sverrirs/jekyll-paginate-v2/blob/master/README-GENERATOR.md#site-configuration
+#   for configuration details
+pagination:
+  # Set enabled to true to use paginate v2
+  enabled: true
+  debug: false
+  collection: "posts"
+  per_page: 10
+  permalink: "/page/:num/"
+  title: ":title - page :num"
+  limit: 0
+  sort_field: "date"
+  sort_reverse: true
+  category: "posts"
+  tag: ""
+  locale: ""
+  trail:
+    before: 2
+    after: 2
+
+# mimic GitHub Pages with --safe
+whitelist:
+  - jekyll-paginate
+  - jekyll-sitemap
+  - jekyll-gist
+  - jekyll-feed
+  - jekyll-include-cache
+
+# Archives
+#  Type
+#  - GitHub Pages compatible archive pages built with Liquid ~> type: liquid (default)
+#  - Jekyll Archives plugin archive pages ~> type: jekyll-archives
+#  Path (examples)
+#  - Archive page should exist at path when using Liquid method or you can
+#    expect broken links (especially with breadcrumbs enabled)
+#  - <base_path>/tags/my-awesome-tag/index.html ~> path: /tags/
+#  - <base_path>/categories/my-awesome-category/index.html ~> path: /categories/
+#  - <base_path>/my-awesome-category/index.html ~> path: /
+category_archive:
+  type: liquid
+  path: /categories/
+tag_archive:
+  type: liquid
+  path: /tags/
+# https://github.com/jekyll/jekyll-archives
+# jekyll-archives:
+#   enabled:
+#     - categories
+#     - tags
+#   layouts:
+#     category: archive-taxonomy
+#     tag: archive-taxonomy
+#   permalinks:
+#     category: /categories/:name/
+#     tag: /tags/:name/
+
+# HTML Compression
+# - https://jch.penibelst.de/
+compress_html:
+  clippings: all
+  ignore:
+    envs: development
+
+# Defaults
+defaults:
+  # _posts
+  - scope:
+      path: ""
+      type: posts
+    values:
+      layout: single
+      author_profile: false
+      read_time: false
+      comments: # true
+      share: false
+      related: false
+  - scope:
+      path: "docs"
+      type: pages
+    values:
+      layout: single
+      author_profile: false
+      sidebar:
+        nav: "sidebar"

data/usechutney.com/_data/navigation.yml

@@ -0,0 +1,112 @@
+# main links
+main:
+  # - title: "Quick-Start Guide"
+    # url: https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/
+  - title: "Documentation"
+    url: /docs/installing/
+  - title: "About"
+    url: /pages/about/
+  # - title: "About"
+  #   url: https://mmistakes.github.io/minimal-mistakes/about/
+  # - title: "Sample Posts"
+  #   url: /year-archive/
+  # - title: "Sample Collections"
+  #   url: /collection-archive/
+  # - title: "Sitemap"
+  #   url: /sitemap/
+
+sidebar:
+  - title: "Getting started"
+    children:
+      - title: "Installing"
+        url: /docs/installing/
+      - title: "Configuration"
+        url: /docs/configuration/
+      - title: "Running Chutney"
+        url: /docs/running/
+      - title: "Disabling rules"
+        url: /docs/disabling-rules/
+
+  - title: "Rules"
+    children:
+      - title: "Avoid full stops"
+        url: /docs/rules/avoid-full-stops/
+      - title: "Avoid outline for single example"
+        url: /docs/rules/avoid-outline-for-single-example/
+      - title: "Avoid scripting"
+        url: /docs/rules/avoid-scripting/
+      - title: "Avoid splat steps in background"
+        url: /docs/rules/avoid-splat-steps-in-background/
+      - title: "Avoid splat steps in scenarios"
+        url: /docs/rules/avoid-splat-steps-in-scenarios/
+      - title: "Avoid typographers' quotes"
+        url: /docs/rules/avoid-typographers-quotes/
+      - title: "Background does more than setup"
+        url: /docs/rules/background-does-more-than-setup/
+      - title: "Background requires multiple scenarios"
+        url: /docs/rules/background-requires-multiple-scenarios/
+      - title: "Bad scenario name"
+        url: /docs/rules/bad-scenario-name/
+      - title: "Empty feature file"
+        url: /docs/rules/empty-feature-file/
+      - title: "File name differs from feature name"
+        url: /docs/rules/file-name-differs-feature-name/
+      - title: "Givens after background"
+        url: /docs/rules/givens-after-background/
+      - title: "Inconsistent quoting"
+        url: /docs/rules/inconsistent-quoting/
+      - title: "Invalid step flow"
+        url: /docs/rules/invalid-step-flow/
+      - title: "Invalid file name"
+        url: /docs/rules/invalid-file-name/
+      - title: "Missing example name"
+        url: /docs/rules/missing-example-name/
+      - title: "Missing example table"
+        url: /docs/rules/missing-example-table/
+      - title: "Missing feature description"
+        url: /docs/rules/missing-feature-description/
+      - title: "Missing feature name"
+        url: /docs/rules/missing-feature-name/
+      - title: "Missing scenario name"
+        url: /docs/rules/missing-scenario-name/
+      - title: "Missing scenario outline"
+        url: /docs/rules/missing-scenario-outline/
+      - title: "Missing Test Action"
+        url: /docs/rules/missing-test-action/
+      - title: "Missing Test Verification"
+        url: /docs/rules/missing-test-verification/
+      - title: "Required tags start with"
+        url: /docs/rules/required-tags-start-with/
+      - title: "Same tag different case"
+        url: /docs/rules/same-tag-different-case/
+      - title: "Same tag for all scenarios"
+        url: /docs/rules/same-tag-for-all-scenarios/
+      - title: "Scenario names match"
+        url: /docs/rules/scenario-names-match/
+      - title: "Tag used multiple times"
+        url: /docs/rules/tag-used-multiple-times/
+      - title: "Too clumsy"
+        url: /docs/rules/too-clumsy/
+      - title: "Too long step"
+        url: /docs/rules/too-long-step/
+      - title: "Too many different tags"
+        url: /docs/rules/too-many-different-tags/
+      - title: "Too many steps"
+        url: /docs/rules/too-many-steps/
+      - title: "Too many tags"
+        url: /docs/rules/too-many-tags/
+      - title: "Unique scenario names"
+        url: /docs/rules/unique-scenario-names/
+      - title: "Unknown variable"
+        url: /docs/rules/unknown-variable/
+      - title: "Unused variable"
+        url: /docs/rules/unused-variable/
+      - title: "Use background"
+        url: /docs/rules/use-background/
+      - title: "Use outline"
+        url: /docs/rules/use-outline/
+
+  - title: "Advanced"
+    children:
+      - title: "Language server"
+        url: /docs/language-server/