Merge branch 'develop'

Author: claytercek

.changeset/serious-paws-train.md

@@ -2,9 +2,11 @@ import jsdoc2md from 'jsdoc-to-markdown';
 import fs from 'fs-extra';
 import path from 'path';
 import chalk from 'chalk';
-import { ConfigManager, LogManager } from '@bluecadet/launchpad-utils';
+import { loadConfigFromFile, LogManager } from '@bluecadet/launchpad-utils';
+import { findConfigFile } from 'typescript';
 
-const config = ConfigManager.getInstance().getConfig();
+const configFile = findConfigFile();
+const config = configFile ? (await loadConfigFromFile(configFile)) : {};
 const logger = LogManager.getInstance(config).getLogger('docs');
 
 /**

.docs/generate.mjs

@@ -23,4 +23,7 @@ jobs:
         run: npm install
 
       - name: Run eslint
-        run: npm run lint
+        run: npm run lint
+
+      - name: Validate types
+        run: npm run build

.github/workflows/main.yml

@@ -27,7 +27,7 @@ jobs:
         id: changesets
         uses: changesets/action@v1
         with:
-          publish: npx changeset publish
+          publish: npm run release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/release.yml

@@ -146,3 +146,6 @@ dist
 
 # changesets
 !.changeset/config.json
+
+# generated .d.ts files
+types

.gitignore

@@ -41,6 +41,5 @@ npm link
 
 cd ../../my-test-project
 @REM If needed: npm init
-npm link @bluecadet/launchpad
-@REM  If needed for your project: npm i @bluecadet/launchpad
+npm link @bluecadet/launchpad --save
 ```

CONTRIBUTING.md

@@ -16,7 +16,9 @@
     "watch-docs": "nodemon",
     "lint": "npx eslint ./packages/**/*.js",
     "lint:fix": "npx eslint ./packages/**/*.js --fix",
-    "lint:fix-dry": "npx eslint ./packages/**/*.js --fix-dry-run"
+    "lint:fix-dry": "npx eslint ./packages/**/*.js --fix-dry-run",
+    "build": "npm run build -w @bluecadet/launchpad",
+    "release": "npm run build && changeset publish"
   },
   "repository": {
     "type": "git",
@@ -34,9 +36,11 @@
   "devDependencies": {
     "@changesets/changelog-github": "^0.4.6",
     "@changesets/cli": "^2.23.0",
+    "@types/node": "^20.3.1",
     "eslint": "^8.32.0",
     "eslint-config-standard": "^17.0.0",
     "jsdoc-to-markdown": "^7.1.1",
-    "nodemon": "^2.0.20"
+    "nodemon": "^2.0.20",
+    "typescript": "^5.1.3"
   }
 }

package.json

@@ -1,5 +1,22 @@
 # @bluecadet/launchpad-content
 
+## 1.12.0
+
+### Minor Changes
+
+- [#128](https://github.com/bluecadet/launchpad/pull/128) [`e11973d`](https://github.com/bluecadet/launchpad/commit/e11973d902f90ef3b94d7e29af23ea766301fc72) Thanks [@claytercek](https://github.com/claytercek)! - Add intellisense support to configs
+
+- [#124](https://github.com/bluecadet/launchpad/pull/124) [`55a98ba`](https://github.com/bluecadet/launchpad/commit/55a98ba9a2a50451fb733a0122f0054c59dc26dd) Thanks [@claytercek](https://github.com/claytercek)! - support js configs
+
+- [#133](https://github.com/bluecadet/launchpad/pull/133) [`4d537f2`](https://github.com/bluecadet/launchpad/commit/4d537f297d9c85b22a35f406e06e15d429ca7eb1) Thanks [@claytercek](https://github.com/claytercek)! - Load dotenv files when launching from CLI
+
+### Patch Changes
+
+- [#118](https://github.com/bluecadet/launchpad/pull/118) [`0aed873`](https://github.com/bluecadet/launchpad/commit/0aed87333dcc3902adb077365a330a8e9190cefa) Thanks [@claytercek](https://github.com/claytercek)! - Generate d.ts declaration files for intellisense, and fix all type errors.
+
+- Updated dependencies [[`e11973d`](https://github.com/bluecadet/launchpad/commit/e11973d902f90ef3b94d7e29af23ea766301fc72), [`55a98ba`](https://github.com/bluecadet/launchpad/commit/55a98ba9a2a50451fb733a0122f0054c59dc26dd), [`4d537f2`](https://github.com/bluecadet/launchpad/commit/4d537f297d9c85b22a35f406e06e15d429ca7eb1), [`0aed873`](https://github.com/bluecadet/launchpad/commit/0aed87333dcc3902adb077365a330a8e9190cefa)]:
+  - @bluecadet/launchpad-utils@1.5.0
+
 ## 1.11.0
 
 ### Minor Changes

packages/content/CHANGELOG.md

@@ -45,54 +45,55 @@ Currently supported sources are:
 
 Some content sources require credentials to access their APIs.
 
-These can all be stored in a local `.credentials.json` file which maps content-source IDs to their credentials. For example:
+These can all be stored in a `.env` or `.env.local` file which will be automatically loaded by launchpad.
 
-### `.credentials.json`
+### `.env.local`
 
-```json
-{
-  "airtable-cms": {
-    "apiKey": "<YOUR_AIRTABLE_API_KEY>"
-  },
-  "contentful-cms": {
-    "previewToken": "<YOUR_CONTENTFUL_PREVIEW_TOKEN>",
-    "deliveryToken": "<YOUR_CONTENTFUL_DELIVERY_TOKEN>",
-    "usePreviewApi": false
-  },
-  "sanity-cms": {
-    "apiToken": "<YOUR_API_TOKEN>"
-  },
-  "strapi-cms": {
-    "identifier": "<YOUR_API_USER>",
-    "password": "<YOUR_API_PASS>"
-  }
-}
+```sh
+AIRTABLE_API_KEY=<YOUR_AIRTABLE_API_KEY>
+
+CONTENTFUL_PREVIEW_TOKEN=<YOUR_CONTENTFUL_PREVIEW_TOKEN>
+CONTENTFUL_DELIVERY_TOKEN=<YOUR_CONTENTFUL_DELIVERY_TOKEN>
+CONTENTFUL_USE_PREVIEW_API=false
+
+SANITY_API_TOKEN=<YOUR_API_TOKEN>
+
+STRAPI_IDENTIFIER=<YOUR_API_USER>
+STRAPI_PASSWORD=<YOUR_API_PASS>
 ```
 
-### `launchpad.json`
+### `launchpad.config.js`
 
 ```js
-{
-  "content": {
-    "sources": [{
-      "id": "airtable-cms",
-      "type": "airtable",
-      //...
-    }, {
-      "id": "contentful-cms",
-      "type": "contentful",
-      //...
-    }, {
-      "id": "sanity-cms",
-      "type": "sanity",
-      //...
-    }, {
-      "id": "strapi-cms",
-      "type": "strapi",
-      //...
-    }]
-  }
-}
+export default defineConfig({
+	content: {
+		sources: [
+			{
+				id: "airtable-cms",
+				type: "airtable",
+				apiKey: process.env.AIRTABLE_API_KEY,
+			},
+			{
+				id: "contentful-cms",
+				type: "contentful",
+				previewToken: process.env.CONTENTFUL_PREVIEW_TOKEN,
+				deliveryToken: process.env.CONTENTFUL_DELIVERY_TOKEN,
+				usePreviewApi: false,
+			},
+			{
+				id: "sanity-cms",
+				type: "sanity",
+				apiToken: process.env.SANITY_API_TOKEN,
+			},
+			{
+				id: "strapi-cms",
+				type: "strapi",
+				identifier: process.env.STRAPI_IDENTIFIER,
+			},
+		],
+	},
+});
+
 ```
 
 ## Post Processing

packages/content/README.md

@@ -9,7 +9,7 @@ Also supports all fields of the Contentful SDK's config.
 See: 'Configuration' under https://contentful.github.io/contentful.js/contentful/9.1.7/
 | Property | Type | Default | Description |
 | - | - | - | - |
-| <a name="module_contentful-source.ContentfulOptions+space">`space`</a> |  <code>string</code>|  <code>''</code>  | Your Contentful space ID. Note that credentials.json will require an accessToken in addition to this |
+| <a name="module_contentful-source.ContentfulOptions+space">`space`</a> |  <code>string</code>|  <code>''</code>  | Your Contentful space ID. Note that an accessToken will be required in addition to this |
 | <a name="module_contentful-source.ContentfulOptions+locale">`locale`</a> |  <code>string</code>|  <code>'en-US'</code>  | Optional. Used to pull localized images. |
 | <a name="module_contentful-source.ContentfulOptions+filename">`filename`</a> |  <code>string</code>|  <code>'content.json'</code>  | Optional. The filename you want to use for where all content (entries and assets metadata) will be stored. |
 | <a name="module_contentful-source.ContentfulOptions+contentTypes">`contentTypes`</a> |  <code>Array.&lt;string&gt;</code>|  | Optionally limit queries to these content types.<br>This will also apply to linked assets.<br>Types that link to other types will include up to 10 levels of child content.<br>E.g. filtering by Story, might also include Chapters and Images.<br>Uses `searchParams['sys.contentType.sys.id[in]']` under the hood. |

packages/content/docs/contentful-source.md

@@ -13,6 +13,6 @@ Options for StrapiSource
 | <a name="module_strapi-source.StrapiOptions+limit">`limit`</a> |  <code>number</code>|  <code>100</code>  | Max number of entries per page. |
 | <a name="module_strapi-source.StrapiOptions+maxNumPages">`maxNumPages`</a> |  <code>number</code>|  <code>-1</code>  | Max number of pages. Use the default of `-1` for all pages |
 | <a name="module_strapi-source.StrapiOptions+pageNumZeroPad">`pageNumZeroPad`</a> |  <code>number</code>|  <code>0</code>  | How many zeros to pad each json filename index with. |
-| <a name="module_strapi-source.StrapiOptions+identifier">`identifier`</a> |  <code>string</code>|  | Username or email. Should be configured via `./credentials.json` |
-| <a name="module_strapi-source.StrapiOptions+password">`password`</a> |  <code>string</code>|  | Should be configured via `./credentials.json` |
+| <a name="module_strapi-source.StrapiOptions+identifier">`identifier`</a> |  <code>string</code>|  | Username or email. Should be configured via `./.env.local` |
+| <a name="module_strapi-source.StrapiOptions+password">`password`</a> |  <code>string</code>|  | Should be configured via `./.env.local` |
 | <a name="module_strapi-source.StrapiOptions+token">`token`</a> |  <code>string</code>|  | Can be used instead of identifer/password if you previously generated one. Otherwise this will be automatically generated using the identifier or password. |

packages/content/docs/strapi-source.md

@@ -8,8 +8,11 @@ export * from './lib/launchpad-content.js';
 export * from './lib/utils/file-utils.js';
 export default LaunchpadContent;
 
+/**
+ * @param {import('./lib/content-options.js').ContentOptions | {content: import('./lib/content-options.js').ContentOptions}} config
+ */
 export const launch = async (config) => {
-	const content = new LaunchpadContent(config.content || config);
+	const content = new LaunchpadContent('content' in config ? config.content : config);
 	await content.start();
 };