babel-plugin-transform-react-templates 0.1.0 → 1.0.0

package/.github/workflows/addtomainproject.yml

@@ -0,0 +1,19 @@
+name: Add to main project
+
+on:
+  issues:
+    types:
+      - opened
+  pull_request:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add to main project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v0.1.0
+        with:
+          project-url: https://github.com/orgs/cgkineo/projects/3/views/1
+          github-token: ${{ secrets.ADDTOPROJECT_TOKEN }}

package/.github/workflows/releases.yml

@@ -0,0 +1,30 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for trusted publishing and npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          registry-url: https://registry.npmjs.org
+      - name: Install dependencies
+        run: npm ci
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx semantic-release

package/README.md

@@ -19,17 +19,37 @@ yarn add babel-plugin-transform-react-templates --dev
 ## Usage
 
 Code:
-```js
-// src/reactTemplateRegister.js
 
-export default register(template, component) {
+```js
+// src/reactTemplateHelpers.js
+export default function register(template, component) {
   templates[template] = component;
 }
 
 export const templates = {};
+```
 
+```js
+// src/templates/test.jsx
+export default (data) => {
+  return <div className="test">
+    {data.testText}
+  </div>
+}
 ```
+
+```js
+// src/main.js
+import { templates } from 'src/reactTemplateHelpers';
+
+ReactDOM.render(templates['test']({
+  testText: 'testing text'
+}), '#app');
+
+```
+
 With options:
+
 ```js
 plugins: [
   [
@@ -39,7 +59,7 @@ plugins: [
         // Any jsx file nested inside a templates folder
         '**/templates/**/*.jsx'
       ],
-      importRegisterFunctionFromModule: 'src/reactTemplateRegister.js',
+      importRegisterFunctionFromModule: 'src/reactTemplateHelpers.js',
       registerFunctionName: 'register',
       registerTemplateName: (moduleId) => {
         // Use filename as template name
@@ -49,3 +69,6 @@ plugins: [
   ]
 ]
 ```
+
+Notes:
+You must inject the template paths if you want them to appear automatically or include them in a normal import.

package/package.json

@@ -1,6 +1,10 @@
 {
   "name": "babel-plugin-transform-react-templates",
-  "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cgkineo/babel-plugin-transform-react-templates"
+  },
+  "version": "1.0.0",
   "description": "Babel plugin to register react templates with a global function",
   "license": "MIT",
   "main": "src/index.js",
@@ -16,6 +20,59 @@
   },
   "devDependencies": {
     "@babel/core": "^7.10.4",
-    "@babel/helper-plugin-test-runner": "^7.10.4"
+    "@babel/helper-plugin-test-runner": "^7.10.4",
+    "@semantic-release/git": "^10.0.1",
+    "conventional-changelog-eslint": "^6.0.0",
+    "semantic-release": "^25.0.2",
+    "semantic-release-replace-plugin": "^1.2.7"
+  },
+  "release": {
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "eslint"
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "eslint"
+        }
+      ],
+      [
+        "semantic-release-replace-plugin",
+        {
+          "replacements": [
+            {
+              "files": "migrations/*.js",
+              "from": "@@CURRENT_VERSION",
+              "to": "${lastRelease.version}",
+              "countMatches": true,
+              "allowEmptyPaths": true
+            },
+            {
+              "files": "migrations/*.js",
+              "from": "@@RELEASE_VERSION",
+              "to": "${nextRelease.version}",
+              "countMatches": true,
+              "allowEmptyPaths": true
+            }
+          ]
+        }
+      ],
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "package.json",
+            "migrations/*.js"
+          ],
+          "message": "Chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        }
+      ]
+    ]
   }
 }