From 10ef765c02e2395577e7b9e31bff4b3b9f553c0c Mon Sep 17 00:00:00 2001 From: Gezim Hoxha Date: Mon, 4 May 2020 07:52:51 -0600 Subject: [PATCH] 1.0.2 --- README.md | 2 +- index.ts | 15 +++++++-------- interfaces.ts | 2 +- logResults.js | 4 ++-- package-lock.json | 2 +- package.json | 2 +- ...mbedLinkNodes.ts => selectPossibleLinkNodes.ts | 2 +- ...embedNode.ts => transformLinkToUnfurledNode.ts | 4 ++-- 8 files changed, 16 insertions(+), 17 deletions(-) rename selectPossibleOembedLinkNodes.ts => selectPossibleLinkNodes.ts (70%) rename transformLinkToOembedNode.ts => transformLinkToUnfurledNode.ts (87%) diff --git a/README.md b/README.md index 1f69510..fa3587d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Transform your boring old blue-underlined links in your Gatsby blog: ![Gatsby Remakr Link Before and After](docs/preview.png) -## Background +## Motivation I've always admired how good links look in Slack. Instead of showing you a measly underlined blue link, Slack show you this: diff --git a/index.ts b/index.ts index 94749f9..4366f9e 100644 --- a/index.ts +++ b/index.ts @@ -1,10 +1,10 @@ import { unfurl } from 'unfurl.js' const fs = require('fs') const path = require('path') -import { selectPossibleOembedLinkNodes } from './selectPossibleOembedLinkNodes' +import { selectPossibleLinkNodes } from './selectPossibleLinkNodes' import logResults from './logResults.js' -import { tranformsLinkNodeToOembedNode } from './transformLinkToOembedNode' -import { IOembed } from './interfaces' +import { tranformsLinkNodeToUnfurledNode } from './transformLinkToUnfurledNode' +import { MetadataInterface } from './interfaces' import { Node } from 'unist' export default async ( @@ -29,7 +29,7 @@ export default async ( fs.writeFileSync(options.processedUrlsFile, '{}') } - const nodes = selectPossibleOembedLinkNodes(markdownAST) + const nodes = selectPossibleLinkNodes(markdownAST) if (nodes.length > 0) { const results = await Promise.all( @@ -42,7 +42,7 @@ export default async ( logResults(results, markdownNode, reporter) } } catch (error) { - reporter.error(`gatsby-remark-oembed: Error processing links`, error) + reporter.error(`gatsby-remark-link-unfurl: Error processing links`, error) } } @@ -50,7 +50,7 @@ export default async ( const processNode = async ( node: any, options: any, - processedUrl: { [key: string]: IOembed } + processedUrl: { [key: string]: MetadataInterface } ): Promise => { try { const metaData = await unfurl(node.url) @@ -78,11 +78,10 @@ const processNode = async ( metaData.open_graph?.site_name || metaData.twitter_card?.site || undefined, - // iframe } } - return tranformsLinkNodeToOembedNode(node, processedUrl[node.url]) + return tranformsLinkNodeToUnfurledNode(node, processedUrl[node.url]) } catch (error) { error.url = node.url return error diff --git a/interfaces.ts b/interfaces.ts index af80344..3fd67ef 100644 --- a/interfaces.ts +++ b/interfaces.ts @@ -1,4 +1,4 @@ -export interface IOembed { +export interface MetadataInterface { title?: string description?: string url: string diff --git a/logResults.js b/logResults.js index 7bb7f9d..99a99ee 100644 --- a/logResults.js +++ b/logResults.js @@ -8,7 +8,7 @@ const logResults = (results, node, reporter) => { if (result instanceof Error) { failedEmbedsCount++; reporter.error( - `gatsby-remark-oembed: Error embedding ${result.url}`, + `gatsby-remark-link-unfurl: Error embedding ${result.url}`, result ); } else if (result) { @@ -18,7 +18,7 @@ const logResults = (results, node, reporter) => { } } - message += `gatsby-remark-oembed:`; + message += `gatsby-remark-link-unfurl:`; message += ` Successful embeds: ${successfulEmbedsCount}`; if (failedEmbedsCount > 0) { diff --git a/package-lock.json b/package-lock.json index 522e67e..931e2d3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "gatsby-remark-link-unfurl", - "version": "1.0.0", + "version": "1.0.2", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 36b538b..f4cff93 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "gatsby-remark-link-unfurl", - "version": "1.0.0", + "version": "1.0.2", "description": "", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/selectPossibleOembedLinkNodes.ts b/selectPossibleLinkNodes.ts similarity index 70% rename from selectPossibleOembedLinkNodes.ts rename to selectPossibleLinkNodes.ts index b257b5a..e1af736 100644 --- a/selectPossibleOembedLinkNodes.ts +++ b/selectPossibleLinkNodes.ts @@ -1,6 +1,6 @@ import { select, selectAll } from 'unist-util-select' import { Node } from 'unist' -export const selectPossibleOembedLinkNodes = markdownAST => { +export const selectPossibleLinkNodes = markdownAST => { return selectAll('paragraph link:only-child', markdownAST) } diff --git a/transformLinkToOembedNode.ts b/transformLinkToUnfurledNode.ts similarity index 87% rename from transformLinkToOembedNode.ts rename to transformLinkToUnfurledNode.ts index 828535e..b1a1a60 100644 --- a/transformLinkToOembedNode.ts +++ b/transformLinkToUnfurledNode.ts @@ -1,7 +1,7 @@ -import { IOembed } from './interfaces' +import { MetadataInterface } from './interfaces' import { Node } from 'unist' import * as mustache from 'mustache' -export const tranformsLinkNodeToOembedNode = (node: Node, card: IOembed) => { +export const tranformsLinkNodeToUnfurledNode = (node: Node, card: MetadataInterface) => { node.type = 'html' const template = `