Merge pull request #16 from zentered/fix/import-errors

andi23rosca · web-flow · commit 5e171bf0b0f4 · 2023-04-03T21:22:40.000+02:00
fix: import errors
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,17 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "node": true
+  },
+  "parser": "@typescript-eslint/parser",
+  "extends": ["eslint:recommended", "prettier", "plugin:solid/recommended"],
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["solid"]
+}
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,19 @@
+name: Publish
+
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 node_modules
-dist
+dist
+.eslintcache
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx commitlint --edit $1
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,2 @@
+example
+.husky
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,6 @@
+{
+  "singleQuote": false,
+  "semi": true,
+  "trailingComma": "es5",
+  "proseWrap": "preserve"
+}
diff --git a/README.md b/README.md
@@ -3,12 +3,14 @@
 The implementation is 90% shamelessly copied from https://github.com/remarkjs/react-markdown.
 
 Changes include:
+
 - Replacing React specific component creation with SolidJS components
 - Porting the implementation from javascript with JSDoc types to typescript
 
 Please check the original repo for in-depth details on how to use.
 
 ## Installation
+
 ```
 npm install solid-markdown
 ```
@@ -24,11 +26,12 @@ const markdown = `
 - here's
 - a
 - list
-`
+`;
 const App = () => {
-  return <SolidMarkdown children={markdown} />
-}
+  return <SolidMarkdown children={markdown} />;
+};
 ```
 
 ## TODO
+
 - [ ] Port unit tests from from original library
diff --git a/babel.config.json b/babel.config.json
@@ -1,6 +1,3 @@
 {
-  "presets": [
-    "solid",
-    "@babel/typescript"
-  ]
-}
+  "presets": ["solid", "@babel/typescript"]
+}
diff --git a/example/README.md b/example/README.md
@@ -7,6 +7,7 @@ This is the reason you see a `pnpm-lock.yaml`. That being said, any package mana
 ```bash
 $ npm install # or pnpm install or yarn install
 ```
+
 ### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
 
 ## Available Scripts
@@ -15,18 +16,15 @@ In the project directory, you can run:
 
 ### `npm dev` or `npm start`
 
-Runs the app in the development mode.<br>
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+Runs the app in the development mode.<br> Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
 The page will reload if you make edits.<br>
 
 ### `npm run build`
 
-Builds the app for production to the `dist` folder.<br>
-It correctly bundles Solid in production mode and optimizes the build for the best performance.
+Builds the app for production to the `dist` folder.<br> It correctly bundles Solid in production mode and optimizes the build for the best performance.
 
-The build is minified and the filenames include the hashes.<br>
-Your app is ready to be deployed!
+The build is minified and the filenames include the hashes.<br> Your app is ready to be deployed!
 
 ## Deployment
 
diff --git a/lib/ast-to-solid.tsx b/lib/ast-to-solid.tsx
@@ -1,3 +1,4 @@
+/* eslint-disable no-unused-vars */
 import type { Position } from "unist";
 import type {
   Element,
diff --git a/lib/complex-types.ts b/lib/complex-types.ts
@@ -1,6 +1,10 @@
 import { Component, JSX } from "solid-js";
-import type { Position } from "unist";
 import type { Element } from "hast";
+import type { Position } from "unist";
+
+/**
+ * @typedef {import('unist').Position} Position
+ */
 
 /* File for types which are not handled correctly in JSDoc mode */
 
@@ -10,7 +14,7 @@ export interface SolidMarkdownProps {
   /**
    * Passed when `options.rawSourcePos` is given
    */
-  sourcePosition?: Position;
+  sourcePosition: Position;
   /**
    * Passed when `options.includeElementIndex` is given
    */
diff --git a/lib/index.tsx b/lib/index.tsx
@@ -1,6 +1,6 @@
 import remarkParse from "remark-parse";
 import remarkRehype from "remark-rehype";
-import { Component, createComponent, JSX, mergeProps } from "solid-js";
+import { Component, mergeProps } from "solid-js";
 import { html } from "property-information";
 import { PluggableList, unified } from "unified";
 import { VFile } from "vfile";
diff --git a/lib/rehype-filter.ts b/lib/rehype-filter.ts
@@ -1,3 +1,4 @@
+/* eslint-disable no-unused-vars */
 import { visit } from "unist-util-visit";
 import type { Element as HElement, Root as HRoot } from "hast";
 import type { Plugin } from "unified";
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tsconfig.json b/tsconfig.json

-Original file line number
+Diff line change
@@ @@ -1,2 +1,3 @@ @@
 node_modules
 -dist
 +dist
 +.eslintcache
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,3 @@`
`1`	`1`	`{`
`2`		`- "presets": [`
`3`		`- "solid",`
`4`		`- "@babel/typescript"`
`5`		`- ]`
`6`		`-}`
	`2`	`+ "presets": ["solid", "@babel/typescript"]`
	`3`	`+}`