update grammar

apps/documentation/.eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": ["plugin:mdx/recommended"],
+  "settings": {
+    "mdx/code-blocks": true
+  },
+  "root": true
+}

apps/documentation/cspell.json

@@ -4,11 +4,16 @@
     "dictionaryDefinitions": [],
     "dictionaries": [],
     "words": [
+        "bento",
         "buildable",
+        "checkcontext",
+        "checkoptions",
         "Codeowner",
         "CODEOWNERS",
         "commonalityco",
         "corepack",
+        "createtestcheck",
+        "falsey",
         "myteam",
         "nextra"
     ],

apps/documentation/package.json

@@ -5,9 +5,10 @@
   "private": true,
   "scripts": {
     "dev": "next dev",
+    "lint": "eslint . --ext md,mdx",
     "build": "next build",
     "start": "next start",
-    "spellcheck": "cspell pages/**/*.mdx"
+    "spellcheck": "cspell **/*.mdx"
   },
   "repository": {
     "type": "git",
@@ -40,6 +41,7 @@
     "@types/node": "18.11.10",
     "autoprefixer": "^10.4.16",
     "cspell": "^8.3.2",
+    "eslint-plugin-mdx": "^2.3.1",
     "postcss": "^8.4.30",
     "tailwindcss": "^3.4.0",
     "typescript": "^4.9.3"

apps/documentation/pages/docs/api/checks.mdx

@@ -44,7 +44,7 @@ const ensureCodeowner = defineCheck(() => {
 `"string" | (options: CheckContext) => Message | Promise<Message>{:ts}`
 </Subtext>
 
-You can pass a static string for simple checks or dynamically return a Message with a function that is passed [CheckContext](#checkoptions).
+You can pass a static string for simple checks or dynamically return a Message with a function that is passed [CheckContext](#checkcontext).
 
 #### Simple message
 
@@ -241,7 +241,7 @@ const ensureCodeowner = defineCheck(() => {
 
 `(check: Check, context?: TestCheckContext) => Check{:ts}`
 
-`createTestCheck` wraps your checks and decorates these functions with sensible defaults for [CheckContext](/docs/api/checks#checkcontext) that you can override. 
+`createTestCheck` wraps your checks and decorates these functions with sensible defaults for [CheckContext](/docs/api/checks#checkcontext) that you can override.
 This cuts down on repetitive boilerplate when writing tests for your checks.
 
 
@@ -257,7 +257,7 @@ A valid [check](/api/checks#check-properties) object
 <Subtext>
 `TestCheckContext{:ts}`
 </Subtext>
-Pass options that will be used as the check's [`CheckContext`](/docs/api/checks#checkcontext). 
+Pass options that will be used as the check's [`CheckContext`](/docs/api/checks#checkcontext).
 If a property is not explicitly passed, the check will be passed a default from the table below.
 
 | Name                    | Default                                   |
@@ -269,7 +269,7 @@ If a property is not explicitly passed, the check will be passed a default from
 | `context.allWorkspaces` | `[{relativePath: './', path: './'}]{:ts}` |
 
 **Returns**
-Returns the original check function, however the `validate`, `fix`, and `message` functions 
+Returns the original check function, however the `validate`, `fix`, and `message` functions
 will be passed the `TestCheckContext` rather than requiring that `CheckContext` be passed.
 
 **Example**
@@ -313,7 +313,7 @@ test('validate - returns true when valid', () => {
 
   const check = createTestCheck(myCheck());
   const result = myCheck.validate();
-  
+
   expect(result).toEqual(true);
 })
 ```

apps/documentation/pages/docs/api/configuration.mdx

@@ -7,7 +7,7 @@ import { Subtext } from '../../../components/subtext.tsx';
 
 **`commonality.config.ts`** **`commonality.config.js`**
 
-Your project's configuration should located be at the root of your project.
+Your project's configuration should be located at the root of your project.
 
 <Callout type="info">
   Use the `defineConfig` helper function to get type checking and intellisense
@@ -62,10 +62,10 @@ import { defineConfig } from 'commonality';
 export default defineConfig({
   constraints: {
     '*': [
-      disallow: ['deployable'],
+      { disallow: ['deployable'] },
     ],
     config: [
-	  allow: ['config']
+	    { allow: ['config'] }
     ],
   },
 });

apps/documentation/pages/docs/api/constraints.mdx

@@ -54,7 +54,7 @@ Commonality will allow all direct dependencies
 
 #### Allow specific direct dependencies
 
-Commonality will only allow direct dependencies that have the `api` or `internal` tag in it's [package configuration](/reference/configuration#package-configuration).
+Commonality will only allow direct dependencies that have the `api` or `internal` tag in its [package configuration](/reference/configuration#package-configuration).
 
 ```json
 {

apps/documentation/pages/docs/checks/testing-checks.mdx

@@ -21,7 +21,7 @@ const ensureLicense = defineCheck((license: string = 'MIT') => {
         path.join(workspace.path, 'package.json'),
       ).get();
 
-      // This check should fail if the package's license does not match the one we specified
+      // This check will fail if the package's license does not match the one specified
       return packageJson.license === license;
     },
     fix: async ({ workspace }) => {
@@ -35,7 +35,7 @@ const ensureLicense = defineCheck((license: string = 'MIT') => {
         path.join(workspace.path, 'package.json'),
       ).get();
 
-      // Since we return multiple messsages we should test for each scenario
+      // Since we return multiple messages we should test for each scenario
       if (!packageJson || !packageJson.license) {
         return {
           title: 'Package.json must have a license',
@@ -145,7 +145,7 @@ describe('ensureLicense', () => {
 
       expect(message.title).toEqual('Package.json license must be MIT');
       expect(message.filePath).toEqual('package.json');
-      // We recommend snapshot testing suggestions as the formatting can be tricky to hardode
+      // We recommend snapshot testing suggestions as the formatting can be tricky to hardcode
       expect(message.suggestion).toMatchInlineSnapshot();
     });
   });