Merging rel/casablanca into master, based on Redocly main

.eslintrc.js

@@ -31,10 +31,18 @@ module.exports = {
     '@typescript-eslint/no-var-requires': 'off',
 
     'react/prop-types': 'off',
-    'react-hooks/rules-of-hooks': 'error',
+    'react-hooks/rules-of-hooks': 'warn',
     'react-hooks/exhaustive-deps': 'warn',
 
-    'import/no-extraneous-dependencies': 'error',
+    'import/no-extraneous-dependencies': [
+      'error',
+      {
+        devDependencies: true,
+        optionalDependencies: false,
+        peerDependencies: false,
+        packageDir: __dirname,
+      },
+    ],
     'import/no-internal-modules': [
       'error',
       {

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+* @Redocly/keyboard-warriors
+/docs/ @Redocly/technical-writers

.github/CONTRIBUTING.md

@@ -1,11 +1,13 @@
-# ReDoc Contributing Guide
+# Redoc Contributing Guide
 
-Hi! We're really excited that you are interested in contributing to ReDoc. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.
+Hi! We're really excited that you are interested in contributing to Redoc. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.
 
-- [Issue Reporting Guidelines](#issue-reporting-guidelines)
-- [Pull Request Guidelines](#pull-request-guidelines)
-- [Development Setup](#development-setup)
-- [Project Structure](#project-structure)
+- [Redoc Contributing Guide](#redoc-contributing-guide)
+  - [Issue Reporting Guidelines](#issue-reporting-guidelines)
+  - [Pull Request Guidelines](#pull-request-guidelines)
+  - [Development Setup](#development-setup)
+    - [Commonly used NPM scripts](#commonly-used-npm-scripts)
+  - [Project Structure](#project-structure)
 
 ## Issue Reporting Guidelines
 - Before filing a new issue, try to make sure your problem doesn’t already exist.
@@ -14,15 +16,15 @@ Hi! We're really excited that you are interested in contributing to ReDoc. Befor
 ## Pull Request Guidelines
 Before submitting a pull request, please make sure the following is done:
 
-1. Fork the repository and create your branch from master.
+1. Fork the repository and create your branch from main.
 2. Run `npm install` in the repository root.
 3. If you’ve fixed a bug or added code that should be tested, add tests!
 4. Ensure the test suite passes (`npm test`). Tip: `npm test -- --watch TestName` is helpful in development.
 5. Format your code with prettier (`npm run prettier`).
 
 ## Development Setup
 
-You will need [Node.js](http://nodejs.org) at `v12.0.0+`.
+You need [Node.js](http://nodejs.org) at `v12.0.0+`.
 
 After cloning the repo, run:
 
@@ -88,7 +90,7 @@ There are some other scripts available in the `scripts` section of the `package.
 
   - **`src/common-elements`**: contains common Styled elements or components used in multiple places
   - **`src/components`**: contains main visual components
-  - **`src/services`**: contains different services used by ReDoc including MobX stores
+  - **`src/services`**: contains different services used by Redoc including MobX stores
   - **`src/services/models`**: contains classes for OpenAPI entities (e.g. Response, Operations, etc)
   - **`src/types`**: contains extra typescript typings including OpenAPI doc typings
   - **`src/utils`**: utility functions

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,7 +2,7 @@
 name: Bug report
 about: Create a report to help us improve
 title: ''
-labels: 'type: bug'
+labels: 'Type: Bug'
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/feature_request.md

@@ -2,7 +2,7 @@
 name: Feature request
 about: Suggest an idea for this project
 title: ''
-labels: ''
+labels: 'Type: Enhancement'
 assignees: ''
 
 ---
@@ -17,4 +17,4 @@ A clear and concise description of what you want to happen.
 A clear and concise description of any alternative solutions or features you've considered.
 
 **Additional context**
-Add any other context or screenshots about the feature request here.
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -2,7 +2,7 @@
 
 ## Reference
 
-## Testing
+## Tests
 
 ## Screenshots (optional)
 

.github/styles/Rules/BritishEnglish.yml

@@ -0,0 +1,110 @@
+extends: substitution
+message: 'Use the US spelling "%s" instead of British "%s".'
+link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words
+level: error
+ignorecase: true
+swap:
+  aeon: eon
+  aeroplane: airplane
+  ageing: aging
+  aluminium: aluminum
+  anaemia: anemia
+  anaesthesia: anesthesia
+  analyse: analyze
+  annexe: annex
+  apologise: apologize
+  behaviour: behavior
+  busses: buses
+  calibre: caliber
+  cancelled: canceled
+  cancellation: cancelation
+  catalogue: catalog
+  categorise: categorize
+  categorised: categorized
+  categorises: categorizes
+  categorising: categorizing
+  centre: center
+  cheque: check
+  civilisation: civilization
+  civilise: civilize
+  colour: color
+  cosy: cozy
+  cypher: cipher
+  dependant: dependent
+  defence: defense
+  distil: distill
+  draught: draft
+  encyclopaedia: encyclopedia
+  enquiry: inquiry
+  enrol: enroll
+  enrolment: enrollment
+  enthral: enthrall
+  expiry: expiration
+  favourite: favorite
+  fibre: fiber
+  fillet: filet
+  flavour: flavor
+  furore: furor
+  fulfil: fulfill
+  gaol: jail
+  grey: gray
+  humour: humor
+  honour: honor
+  initialled: initialed
+  initialling: initialing
+  instil: instill
+  jewellery: jewelry
+  labelling: labeling
+  labelled: labeled
+  labour: labor
+  libellous: libelous
+  licence: license
+  likeable: likable
+  liveable: livable
+  lustre: luster
+  manoeuvre: maneuver
+  marvellous: marvelous
+  matt: matte
+  meagre: meager
+  metre: meter
+  modelling: modeling
+  moustache: mustache
+  neighbour: neighbor
+  normalise: normalize
+  offence: offense
+  organise: organize
+  organisation: organization
+  orientated: oriented
+  paralyse: paralyze
+  plough: plow
+  pretence: pretense
+  programme: program
+  pyjamas: pajamas
+  rateable: ratable
+  realise: realize
+  recognise: recognize
+  reconnoitre: reconnoiter
+  rumour: rumor
+  sabre: saber
+  saleable: salable
+  saltpetre: saltpeter
+  sceptic: skeptic
+  sepulchre: sepulcher
+  signalling: signaling
+  sizeable: sizable
+  skilful: skillful
+  sombre: somber
+  smoulder: smolder
+  speciality: specialty
+  spectre: specter
+  splendour: splendor
+  standardise: standardize
+  standardised: standardized
+  sulphur: sulfur
+  theatre: theater
+  travelled: traveled
+  traveller: traveler
+  travelling: traveling
+  unshakeable: unshakable
+  wilful: willful
+  yoghurt: yogurt

.github/styles/Rules/FutureTense.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: 'Avoid using future tense: "%s". Use present tense instead.'
+link: https://intranet.redoc.ly/contributing/documentation-style-guide/#tone-and-audience
+ignorecase: true
+level: error
+raw:
+  - "(going to( |\n|[[:punct:]])[a-zA-Z]*|"
+  - "will( |\n|[[:punct:]])[a-zA-Z]*|"
+  - "won't( |\n|[[:punct:]])[a-zA-Z]*|"
+  - "[a-zA-Z]*'ll( |\n|[[:punct:]])[a-zA-Z]*)"

.github/styles/Rules/HeaderGerunds.yml

@@ -0,0 +1,11 @@
+extends: existence
+message: 'Do not start headings with with a gerund (ing word). Use an imperative verb instead.'
+link: https://intranet.redoc.ly/contributing/documentation-style-guide/#content-organization
+level: error
+scope: heading
+tokens:
+  - '^\w*ing.*'
+exceptions:
+  - expandSingleSchemaField
+  - hideLoading
+  - hideSingleRequestSampleTab

.github/styles/Rules/InclusionGenderCulture.yml

@@ -0,0 +1,16 @@
+extends: substitution
+message: 'Use inclusive language. Consider "%s" instead of "%s".'
+link: https://intranet.redoc.ly/contributing/documentation-style-guide/#grammar-and-syntax
+level: error
+ignorecase: true
+swap:
+  he: they
+  his: their
+  she: they
+  hers: their
+  blacklist(?:ed|ing|s)?: blocklist
+  whitelist(?:ed|ing|s)?: allowlist
+  master: primary, main
+  slave: replica
+  he/she: they
+  s/he: they

.github/styles/Rules/OxfordComma.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: "Use the Oxford comma in '%s'."
+link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas
+scope: sentence
+level: error
+nonword: true
+tokens:
+  - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]'