Better eslint configuration and format some files

rairprotocol · Aug 23, 2023 · c1f36e9 · c1f36e9
1 parent da8ef74
commit c1f36e9
Show file tree

Hide file tree

Showing 10 changed files with 37 additions and 43 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,11 +1,14 @@
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   env: {
     node: true,
     es2022: true,
     browser: true,
   },
   extends: ['eslint:recommended', 'plugin:astro/recommended'],
+  parser: '@typescript-eslint/parser',
   parserOptions: {
+    tsconfigRootDir: __dirname,
     ecmaVersion: 'latest',
     sourceType: 'module',
   },

diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 
 ## Features
 
-- ✅ Integration with **Tailwind CSS** ([@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/)) supporting **Dark mode** and ***RTL***.
+- ✅ Integration with **Tailwind CSS** ([@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/)) supporting **Dark mode** and **_RTL_**.
 - ✅ **Production-ready** scores in [Lighthouse](https://web.dev/measure/) and [PageSpeed Insights](https://pagespeed.web.dev/) reports.
 - ✅ **Fast and SEO friendly blog** with automatic **RSS feed** ([@astrojs/rss](https://docs.astro.build/en/guides/rss/)), [**MDX** support](https://docs.astro.build/en/guides/integrations-guide/mdx/), **Categories & Tags**, **Social Share**, ...
 - ✅ **Image Optimization** (using new [Astro Assets](https://astro.build/blog/images/) and [Unpic](https://unpic.pics/lib/) for Universal image CDN) and **Font optimization**.

diff --git a/astro.config.mjs b/astro.config.mjs
@@ -9,7 +9,7 @@ import mdx from '@astrojs/mdx';
 import partytown from '@astrojs/partytown';
 import compress from 'astro-compress';
 import icon from 'astro-icon';
-import tasks from "./src/utils/tasks";
+import tasks from './src/utils/tasks';
 
 import { readingTimeRemarkPlugin } from './src/utils/frontmatter.mjs';
 
@@ -32,7 +32,7 @@ export default defineConfig({
   output: 'static',
 
   build: {
-    inlineStylesheets: 'auto'
+    inlineStylesheets: 'auto',
   },
 
   integrations: [

diff --git a/public/decapcms/config.yml b/public/decapcms/config.yml
@@ -2,33 +2,28 @@ backend:
   name: git-gateway
   branch: main
 
-media_folder: "src/assets/images"
-public_folder: "/_astro"
+media_folder: 'src/assets/images'
+public_folder: '/_astro'
 
 collections:
-  - name: "post"
-    label: "Post"
-    folder: "src/content/post"
+  - name: 'post'
+    label: 'Post'
+    folder: 'src/content/post'
     create: true
     fields:
-      - { label: "Title", name: "title", widget: "string" }
-      - { label: "Excerpt", name: "excerpt", widget: "string" }
-      - { label: "Category", name: "category", widget: "string" }
+      - { label: 'Title', name: 'title', widget: 'string' }
+      - { label: 'Excerpt', name: 'excerpt', widget: 'string' }
+      - { label: 'Category', name: 'category', widget: 'string' }
       - {
-          label: "Tags",
-          name: "tags",
-          widget: "list",
+          label: 'Tags',
+          name: 'tags',
+          widget: 'list',
           allow_add: true,
           allow_delete: true,
           collapsed: false,
-          field: { label: "Tag", name: "tag", widget: "string" },
+          field: { label: 'Tag', name: 'tag', widget: 'string' },
         }
-      - { label: "Image", name: "image", widget: "string" }
-      - {
-          label: "Publish Date",
-          name: "publishDate",
-          widget: "datetime",
-          required: false,
-        }
-      - { label: "Author", name: "author", widget: "string" }
-      - { label: "Content", name: "body", widget: "markdown" }
+      - { label: 'Image', name: 'image', widget: 'string' }
+      - { label: 'Publish Date', name: 'publishDate', widget: 'datetime', required: false }
+      - { label: 'Author', name: 'author', widget: 'string' }
+      - { label: 'Content', name: 'body', widget: 'markdown' }
diff --git a/public/decapcms/index.html b/public/decapcms/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html>
   <head>
     <meta charset="utf-8" />

diff --git a/src/content/post/astrowind-template-in-depth.mdx b/src/content/post/astrowind-template-in-depth.mdx
@@ -37,8 +37,8 @@ The styling mechanism consists of the following files (all paths are prefixed wi
   header section. See next.
 </DListItem>
 <DListItem dt="layouts/Layout.astro">
-  This layout is used for all of the pages rendered by _AstroWind_. The contents of _tailwind.css_ and _CustomStyles.astro_ component,
-  described above, is injected into the html header.
+  This layout is used for all of the pages rendered by _AstroWind_. The contents of _tailwind.css_ and
+  _CustomStyles.astro_ component, described above, is injected into the html header.
 </DListItem>
 
 ### Dark Mode

diff --git a/src/pages/rss.xml.ts b/src/pages/rss.xml.ts
@@ -14,9 +14,9 @@ export const GET = async () => {
 
   const posts = await fetchPosts();
 
-  const { body = "" } = await rss({
+  const { body = '' } = await rss({
     title: `${SITE.name}’s Blog`,
-    description: METADATA?.description || "",
+    description: METADATA?.description || '',
     site: import.meta.env.SITE,
 
     items: posts.map((post) => ({
@@ -27,12 +27,12 @@ export const GET = async () => {
     })),
 
     trailingSlash: SITE.trailingSlash,
-  })
+  });
 
   return new Response(body, {
     status: 200,
     headers: {
-      "Content-Type": "application/xml"
-    }
+      'Content-Type': 'application/xml',
+    },
   });
 };
diff --git a/src/utils/config.ts b/src/utils/config.ts
@@ -20,7 +20,7 @@ export interface MetaDataConfig extends Omit<MetaData, 'title'> {
 export interface I18NConfig {
   language: string;
   textDirection: string;
-  dateFormatter: unknown;
+  dateFormatter?: Intl.DateTimeFormat;
 }
 export interface AppBlogConfig {
   isEnabled: boolean;

diff --git a/src/utils/images.ts b/src/utils/images.ts
@@ -21,7 +21,9 @@ export const fetchLocalImages = async () => {
 };
 
 /** */
-export const findImage = async (imagePath?: string | ImageMetadata | null): Promise<string | ImageMetadata | undefined | null> => {
+export const findImage = async (
+  imagePath?: string | ImageMetadata | null
+): Promise<string | ImageMetadata | undefined | null> => {
   // Not string
   if (typeof imagePath !== 'string') {
     return imagePath;
@@ -94,4 +96,4 @@ export const adaptOpenGraphImages = async (
   );
 
   return { ...openGraph, ...(adaptedImages ? { images: adaptedImages } : {}) };
-};
+};
diff --git a/src/utils/utils.ts b/src/utils/utils.ts
@@ -1,6 +1,6 @@
 import { I18N } from '~/utils/config';
 
-const formatter =
+const formatter: Intl.DateTimeFormat =
   I18N?.dateFormatter ||
   new Intl.DateTimeFormat('en', {
     year: 'numeric',
@@ -9,13 +9,7 @@ const formatter =
     timeZone: 'UTC',
   });
 
-/* eslint-disable no-mixed-spaces-and-tabs */
-export const getFormattedDate = (date: Date) =>
-  date
-    ? // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      /* @ts-ignore */
-      formatter.format(date)
-    : '';
+export const getFormattedDate = (date: Date): string => (date ? formatter.format(date) : '');
 
 export const trim = (str = '', ch?: string) => {
   let start = 0,