Using specified property for markdown filename

.github/workflows/test.yml

@@ -2,17 +2,15 @@ name: 'build-test'
 
 on: # rebuild any PRs and main branch changes
   pull_request:
-  push:
-    branches:
-      - main
-      - 'v*'
 
 jobs:
   build: # make sure build/ci work properly
     runs-on: ubuntu-latest
     timeout-minutes: 3
     steps:
       - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
 
       - name: Set Node.js 16.x
         uses: actions/setup-node@v3
@@ -29,9 +27,25 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 3
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout source
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Normal test
+        uses: ./
+        env:
+          NOTION_API_KEY: ${{ secrets.NOTION_API_KEY }}
+          NOTION_DATABASE_ID: ${{ secrets.NOTION_DATABASE_ID }}
+          ACTIONS_STEP_DEBUG: true
+          ACTIONS_RUNNER_DEBUG: true
 
-      - uses: ./
+      - name: Specific property as a markdown filename
+        uses: ./
+        with:
+          filename_property: 'slug'
         env:
           NOTION_API_KEY: ${{ secrets.NOTION_API_KEY }}
           NOTION_DATABASE_ID: ${{ secrets.NOTION_DATABASE_ID }}
+          ACTIONS_STEP_DEBUG: true
+          ACTIONS_RUNNER_DEBUG: true

README.md

@@ -11,10 +11,10 @@ This action converts and downloads pages that exist in Notion's specified databa
 
 ## Usage
 
-`.github/workflows/download.yml`
+`.github/workflows/import.yml`
 
 ```yaml
-name: download
+name: import
 
 on:
   schedule:

action.yml

@@ -12,6 +12,10 @@ inputs:
     required: false
     description: 'Directory path to output files.'
     default: 'output'
+  filename_property:
+    required: false
+    description: 'A property to be used as the markdown file name.'
+    default: 'title'
 runs:
   using: 'node16'
   main: 'dist/index.js'

package.json

@@ -1,13 +1,13 @@
 {
   "name": "notion-to-markdown-action",
-  "version": "0.1.5",
+  "version": "0.2.1",
   "private": true,
   "description": "Convert notion pages to markdown files action",
   "main": "lib/main.js",
   "scripts": {
     "build": "tsc",
     "build:watch": "tsc -w",
-    "start": "node ./dist/index.js",
+    "start": "ACTIONS_RUNNER_DEBUG=true ACTIONS_STEP_DEBUG=true node ./dist/index.js",
     "format": "prettier --write '**/*.ts'",
     "format-check": "prettier --check '**/*.ts'",
     "lint": "eslint src/**/*.ts",

src/main.ts

@@ -10,13 +10,20 @@ import {
   findImagesFromMarkdown,
   MarkdownPage
 } from './utils/markdown';
-
-const DEFAULT_OUTPUT = 'output';
+import {
+  DEFAULT_FILENAME_PROPERTY,
+  DEFAULT_OUTPUT_DIR
+} from './utils/constants';
 
 const auth = process.env.NOTION_API_KEY as string;
 const databaseId = process.env.NOTION_DATABASE_ID as string;
 
-const run = async (auth: string, databaseId: string, outDir: string) => {
+const run = async (
+  auth: string,
+  databaseId: string,
+  outDir: string,
+  filenameProperty: string
+) => {
   const client = new Client({ auth });
 
   info('Call "Query a Database" API ...');
@@ -25,7 +32,11 @@ const run = async (auth: string, databaseId: string, outDir: string) => {
 
   info('Convert notion pages to markdown files ...');
 
-  const mdResponse = await convertPagesToMarkdown(client, pages);
+  const mdResponse = await convertPagesToMarkdown(
+    client,
+    pages,
+    filenameProperty
+  );
 
   info('---> Successfully converted from notion pages to markdown files!');
 
@@ -71,7 +82,12 @@ const downloadImages = async (filename: string, outDir: string) => {
   }
 };
 
-run(auth, databaseId, getInput('output_path') || DEFAULT_OUTPUT).catch((e) => {
+run(
+  auth,
+  databaseId,
+  getInput('output_path') || DEFAULT_OUTPUT_DIR,
+  getInput('filename_property') || DEFAULT_FILENAME_PROPERTY
+).catch((e) => {
   error(e);
   setFailed(e.message);
 });

src/utils/constants.ts

@@ -0,0 +1,2 @@
+export const DEFAULT_OUTPUT_DIR = 'output';
+export const DEFAULT_FILENAME_PROPERTY = 'title';

src/utils/markdown.ts

@@ -27,15 +27,17 @@ export const convertPagesToMarkdown = async (
   notionClient: Client,
   pages: (PageObjectResponse & {
     frontmatter: Frontmatter;
-  })[]
+  })[],
+  prop: string
 ): Promise<MarkdownPage[]> => {
   const n2m = new NotionToMarkdown({ notionClient });
   return Promise.all(
     pages.map(async (page) => {
       const frontmatter = renderedMatter(page.frontmatter);
       const markdown = await pageToMarkdown(n2m, page.id);
+      const filename = slug(detectFilenameFromProperty(page.frontmatter, prop));
       return {
-        filename: slug(page.frontmatter.title),
+        filename,
         body: format([frontmatter, markdown].join('\n'), { parser: 'markdown' })
       };
     })
@@ -74,3 +76,13 @@ export const findImagesFromMarkdown = async (filename: string) => {
   }
   return { images, content };
 };
+
+const detectFilenameFromProperty = (frontmatter: Frontmatter, prop: string) => {
+  if (prop === 'title' || !(prop in frontmatter)) {
+    return frontmatter.title;
+  }
+
+  return typeof frontmatter[prop] === 'string'
+    ? (frontmatter[prop] as string)
+    : frontmatter.title;
+};