v9 roadmap

[kanadgupta]

v9

• some sort of deprecation notice for rdme openapi? #1106
• feat!: deprecation notices for non-readme-refactored commands #1099
• docs: migration guide #1098
• feat!: switch topic separator to space #1100
• remove old command reference language from main README, in favor of new autogenerated CLI reference docs in documentation/commands.md
• get dist-gha/ directory to update with every new release f42392b
• feat!: remove validate, deprecate/hide open #1072
• feat: oclif #962, feat: oclif (take 2) #1068
  • update GHA build process to reflect oclif setup
• update MAINTAINERS.md
• Auto-publish GitHub releases (e.g., remove gh CLI usage) 331d28b
• Make sure JSON import assertions are future-proof (or aren't used at all) fix: use newest import attributes syntax #993
• refactor: enable TS strict mode #889
• Migrate to ESM (feat: convert to ESM (breaking change) #856)
  • Do some QA to ensure no Node ExperimentalWarnings show up fix: hide ExperimentalWarning #901
• Drop support for Node <20 (release schedule) feat: support node 18 and up #900 feat!: drop node 18 #1085
  • Bump lockfile to v3
• Remove docs:edit command refactor: remove oas, swagger, docs:edit #902
• Remove oas command refactor: remove oas, swagger, docs:edit #902
• Remove swagger command refactor: remove oas, swagger, docs:edit #902
• (Probably separate from the ESM migration) look into any clean-up/modernizations we can do in the tsconfig chore: tsconfig cleanup #905
• flip the isPublic flag in the versions:create and versions:update commands to be hidden so it's consistent with the other flags and with our API endpoints feat(versions): flag parity with API, copy fixes #906
• feat: use actions/checkout@v4 everywhere #895
• feat(test): moving unit tests over to vitest #857
• Use native Node 18 fetch and FormData and msw in favor of node-fetch and nock and formdata-node, convert everything over accordingly feat(fetch): use undici + ProxyAgent  #1000
• Add deprecation notice to docs commands (edit: cancelling this)

[kanadgupta]

Maybe we also migrate to ESM? 😬

[erunion]

fwiw, iirc last time i looked into that you still needed to pass the --experimental flag to Node for ESM in order to run bin/rdme. That was like a year and a half ago though, and before we migrated to TS, so maybe things are different now.

[kanadgupta]

maybe we also drop Node 16 support also when that is EOL in a few weeks. we'll want to bump the version here (in addition to everywhere else):

rdme/Dockerfile

Line 1 in 9756d95

FROM node:16-alpine as builder

[erunion]

Now that we've got rdme guides and rdme guides:prune aliased to rdme docs:<cmd> can we deprecate and remove rdme docs?

[kanadgupta]

@erunion ah yeah good callout — definitely down to add a deprecation notice but i don't think we should remove those until we're using the new /guides routes

[erunion]

For dumping node-fetch and formdata-node for native fetch the place where you're using formdata-node in #856 can be replaced with this diff:

diff --git a/src/lib/streamSpecToRegistry.ts b/src/lib/streamSpecToRegistry.ts
index a73445f..9d4f68a 100644
--- a/src/lib/streamSpecToRegistry.ts
+++ b/src/lib/streamSpecToRegistry.ts
@@ -1,8 +1,4 @@
-import fs from 'node:fs';
-
-import { FormData } from 'formdata-node';
 import ora from 'ora';
-import { file as tmpFile } from 'tmp-promise';
 
 import { debug, oraOptions } from './logger.js';
 import readmeAPIFetch, { handleRes } from './readmeAPIFetch.js';
@@ -15,23 +11,15 @@ import readmeAPIFetch, { handleRes } from './readmeAPIFetch.js';
  */
 export default async function streamSpecToRegistry(spec: string) {
   const spinner = ora({ text: 'Staging your API definition for upload...', ...oraOptions() }).start();
-  // Create a temporary file to write the bundled spec to,
-  // which we will then stream into the form data body
-  const { path } = await tmpFile({ prefix: 'rdme-openapi-', postfix: '.json' });
-  debug(`creating temporary file at ${path}`);
-  await fs.writeFileSync(path, spec);
-  const stream = fs.createReadStream(path);
-
-  debug('file and stream created, streaming into form data payload');
+  debug('preparing spec into form data payload');
   const formData = new FormData();
-  formData.append('spec', {
-    type: 'application/json',
-    name: 'openapi.json',
-    [Symbol.toStringTag]: 'File',
-    stream() {
-      return stream;
-    },
-  });
+  formData.append(
+    spec,
+    new Blob([spec], {
+      type: 'application/json',
+    }),
+    'openapi.json',
+  );
 
   const options = {
     body: formData,

[kanadgupta]

🚀 https://github.com/readmeio/rdme/releases/tag/v9.0.0