Better api name (#356)

Author: chenglou

scripts/test-hrefs.mjs

@@ -15,7 +15,7 @@ import fs from "fs";
 import urlModule from "url";
 import { URL } from 'url';
 import {data as blogIndex} from '../src/BlogData.mjs'
-import {getSlugFromPath} from '../src/common/BlogApi.mjs'
+import {blogPathToSlug} from '../src/common/BlogApi.mjs'
 
 const __dirname = new URL('.', import.meta.url).pathname;
 
@@ -26,7 +26,7 @@ const mapBlogFilePath = path => {
     let relPath = match[1];
     let path = blogIndex.find((path) => path === relPath);
     if (path != null) {
-      return `./pages/blog/${getSlugFromPath(path)}`;
+      return `./pages/blog/${blogPathToSlug(path)}`;
     }
     return path;
   }

src/Blog.mjs

@@ -323,7 +323,7 @@ function getStaticProps(_ctx) {
           var archived = acc[2];
           var malformed = acc[1];
           var posts = acc[0];
-          var id = BlogApi.getSlugFromPath(postData.path);
+          var id = BlogApi.blogPathToSlug(postData.path);
           var decoded = BlogFrontmatter.decode(postData.frontmatter);
           if (decoded.TAG === /* Ok */0) {
             var frontmatter = decoded._0;

src/Blog.res

@@ -372,7 +372,7 @@ let getStaticProps: Next.GetStaticProps.t<props, params> = _ctx => {
     postData,
   ) => {
     let (posts, malformed, archived) = acc
-    let id = BlogApi.getSlugFromPath(postData.path)
+    let id = BlogApi.blogPathToSlug(postData.path)
 
     let decoded = BlogFrontmatter.decode(postData.frontmatter)
 

src/BlogArticle.mjs

@@ -195,7 +195,7 @@ function $$default(props) {
 function getStaticProps(ctx) {
   var params = ctx.params;
   var slug = BlogData.data.find(function (path2) {
-        return BlogApi.getSlugFromPath(path2) === params.slug;
+        return BlogApi.blogPathToSlug(path2) === params.slug;
       });
   var path = slug !== undefined ? slug : params.slug;
   var props = {
@@ -210,7 +210,7 @@ function getStaticPaths(param) {
   var paths = Belt_Array.map(BlogApi.getAllPosts(undefined), (function (postData) {
           return {
                   params: {
-                    slug: BlogApi.getSlugFromPath(postData.path)
+                    slug: BlogApi.blogPathToSlug(postData.path)
                   }
                 };
         }));

src/BlogArticle.res

@@ -226,7 +226,7 @@ let getStaticProps: Next.GetStaticProps.t<props, Params.t> = ctx => {
   let {params} = ctx
 
   let path = switch BlogData.data->Js.Array2.find(path2 =>
-    BlogApi.getSlugFromPath(path2) == params.slug
+    BlogApi.blogPathToSlug(path2) == params.slug
   ) {
   | None => params.slug
   | Some(slug) => slug
@@ -242,7 +242,7 @@ let getStaticPaths: Next.GetStaticPaths.t<Params.t> = () => {
 
   let paths = BlogApi.getAllPosts()->Belt.Array.map(postData => {
     params: {
-      Params.slug: BlogApi.getSlugFromPath(postData.path),
+      Params.slug: BlogApi.blogPathToSlug(postData.path),
     },
   })
   let ret = {paths: paths, fallback: false}

src/common/BlogApi.mjs

@@ -11,7 +11,7 @@ import * as Caml_option from "rescript/lib/es6/caml_option.js";
 import GrayMatter from "gray-matter";
 import * as BlogFrontmatter from "./BlogFrontmatter.mjs";
 
-function getSlugFromPath(path) {
+function blogPathToSlug(path) {
   return path.replace(/(archive\/)?\d\d\d\d-\d\d-\d\d-/, "");
 }
 
@@ -50,7 +50,7 @@ function getLatest(maxOpt, baseUrlOpt, param) {
                     var fm$1 = fm._0;
                     var description = Belt_Option.getWithDefault(Caml_option.null_to_opt(fm$1.description), "");
                     var item_title = fm$1.title;
-                    var item_href = baseUrl + ("/blog/" + getSlugFromPath(next.path));
+                    var item_href = baseUrl + ("/blog/" + blogPathToSlug(next.path));
                     var item_pubDate = DateStr.toDate(fm$1.date);
                     var item = {
                       title: item_title,
@@ -96,7 +96,7 @@ var RssFeed = {
 
 export {
   getAllPosts ,
-  getSlugFromPath ,
+  blogPathToSlug ,
   RssFeed ,
 
 }

src/common/BlogApi.res

@@ -39,7 +39,7 @@ type postData = {
   frontmatter: Js.Json.t,
 }
 
-let getSlugFromPath = path => {
+let blogPathToSlug = path => {
   path->Js.String2.replaceByRe(%re(`/(archive\/)?\d\d\d\d-\d\d-\d\d-/`), "")
 }
 
@@ -107,7 +107,7 @@ module RssFeed = {
           let description = Js.Null.toOption(fm.description)->Belt.Option.getWithDefault("")
           let item = {
             title: fm.title,
-            href: baseUrl ++ ("/blog/" ++ getSlugFromPath(next.path)),
+            href: baseUrl ++ ("/blog/" ++ blogPathToSlug(next.path)),
             description: description,
             pubDate: DateStr.toDate(fm.date),
           }

src/common/BlogApi.resi

@@ -6,7 +6,7 @@ type postData = {
 }
 
 let getAllPosts: unit => array<postData>
-let getSlugFromPath: string => string
+let blogPathToSlug: string => string
 
 module RssFeed: {
   type item = {