Merge pull request #194 from orgapp/esm

migrate to ESM

Author: xiaoxinghu

.changeset/beige-glasses-hang.md

@@ -0,0 +1,28 @@
+---
+'gatsby-plugin-orga': major
+'@orgajs/rehype-estree': major
+'oast-to-hast': major
+'@orgajs/reorg-rehype': major
+'@orgajs/reorg-parse': major
+'@orgajs/estree-jsx': major
+'@orgajs/metadata': major
+'text-kit': major
+'@orgajs/loader': major
+'@orgajs/rollup': major
+'@orgajs/astro': major
+'@orgajs/react': major
+'@orgajs/reorg': major
+'@orgajs/next': major
+'orga': major
+'@orgajs/orgx': major
+---
+
+# Migrate most of the ecosystem to ESM
+
+We are excited to announce that we have migrated most of our ecosystem to ESM! This move was necessary as the unified ecosystem had already transitioned to ESM, leaving our orgajs system stuck on an older version if we wanted to stay on commonjs. We understand that this transition may come with some inevitable breaking changes, but we have done our best to make it as gentle as possible.
+
+In the past, ESM support in popular frameworks like webpack, gatsby, and nextjs was problematic, but the JS world has steadily moved forward, and we are now in a much better state. We have put in a lot of effort to bring this project up to speed, and we are happy to say that it's in a pretty good state now.
+
+We acknowledge that there are still some missing features that we will gradually add back over time. However, we feel that the changes are now in a great state to be released to the world. If you want to use the new versions, we recommend checking out the `examples` folder to get started.
+
+We understand that this upgrade path may not be compatible with older versions, and we apologize for any inconvenience this may cause. However, we encourage you to consider starting fresh, as the most important part of your site should always be your content (org-mode files). Thank you for your understanding, and we hope you enjoy the new and improved ecosystem!

.editorconfig

@@ -9,7 +9,7 @@ insert_final_newline = true
 [vcbuild.bat]
 end_of_line = crlf
 
-[*.{js,jsx,ts,tsx,css,json}]
+[*.{js,cjs,mjs,jsx,ts,tsx,css,json,astro}]
 indent_style = space
 indent_size = 2
 

.eslintrc.js

@@ -3,9 +3,14 @@ module.exports = {
   env: {
     node: true,
     browser: true,
-    jest: true,
+    es6: true,
   },
-  extends: ['eslint:recommended', 'plugin:react/recommended'],
+  extends: [
+    'eslint:recommended',
+    'plugin:react/recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
+  ],
   parserOptions: {
     ecmaVersion: 2020,
     sourceType: 'module',
@@ -19,12 +24,20 @@ module.exports = {
         extensions: ['.js', '.jsx', '.ts', '.tsx', '.d.ts'],
         paths: ['node_modules/', 'node_modules/@types/'],
       },
+      typescript: {
+        alwaysTryTypes: true, // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
+        project: 'packages/*/tsconfig.json',
+      },
+    },
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts', '.tsx'],
     },
   },
   rules: {
     'import/no-extraneous-dependencies': ['warn'],
     semi: ['error', 'never'],
     'react/react-in-jsx-scope': 'off',
+    'react/prop-types': 'off',
   },
   overrides: [
     {

.github/workflows/ci.yml

@@ -16,13 +16,15 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Use Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18.x
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8.0.0
       - name: run unit tests
         run: |
-          yarn install --immutable
-          yarn build
-          yarn test
+          pnpm install
+          pnpm test

.github/workflows/release.yml

@@ -5,24 +5,43 @@ on:
     branches:
       - main
 
+env:
+  CI: true
+  PNPM_CACHE_FOLDER: .pnpm-store
+
 jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@master
+        uses: actions/checkout@v3
         with:
           # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
           fetch-depth: 0
 
-      - name: Setup Node.js 14.x
-        uses: actions/setup-node@master
+      - name: Setup Node.js 18.x
+        uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 18.x
 
-      - name: Install Dependencies
-        run: yarn install --immutable
+      - name: install pnpm
+        run: npm i pnpm@latest -g
+      - name: Setup npmrc
+        run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > .npmrc
+      - name: setup pnpm config
+        run: pnpm config set store-dir $PNPM_CACHE_FOLDER
+      - name: install dependencies
+        run: pnpm install
+      - name: create and publish versions
+        uses: changesets/action@v1
+        with:
+          version: pnpm ci:version
+          commit: 'chore: update versions'
+          title: 'chore: update versions'
+          publish: pnpm ci:publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
 
       - name: Create Release Pull Request or Publish to npm
         id: changesets
@@ -32,6 +51,4 @@ jobs:
           version: yarn version-packages
           publish: yarn release
         env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-

.gitignore

@@ -89,19 +89,15 @@ typings/
 # next.js build output
 .next
 
-lib
-dist
 .npmrc
-*.tsbuildinfo
 
 # private
 .archive
 
-# yarn 2
-.yarn/*
-!.yarn/patches
-!.yarn/releases
-!.yarn/plugins
-!.yarn/sdks
-!.yarn/versions
-.pnp.*
+/.idea
+.vscode
+
+# build artifacts
+dist
+*.tsbuildinfo
+packages/rollup/**/*.d.ts

.tool-versions

@@ -0,0 +1 @@
+nodejs lts-hydrogen