@nzambello/link-previewer

link-previewer

Node util to retrieve preview info from a link (og tags, meta tags, images, videos).

Installation

yarn add @nzambello/link-previewer

npm install @nzambello/link-previewer

Usage

import type { ILinkPreviewInfo } from '@nzambello/link-previewer';
import getLinkPreview from '@nzambello/link-previewer';

getLinkPreview('https://www.youtube.com/watch?v=feH26j3rBz8').then(console.log);

Result

{
  "description": "How much do we know about the impact of technologies we use everyday? How much the web industry is responsible for carbon emissions? Can we define an ethic d...",
  "favicon": "https://www.youtube.com/s/desktop/ce262d3b/img/favicon.ico",
  "image": "https://i.ytimg.com/vi/feH26j3rBz8/maxresdefault.jpg",
  "imageHeight": 720,
  "imageWidth": 1280,
  "images": [],
  "mediaType": "video.other",
  "siteName": "YouTube",
  "title": "A sustainable web: is it possible? - Nicola Zambello",
  "video": "https://www.youtube.com/embed/feH26j3rBz8",
  "videos": []
}

Development

To run TSDX, use:

npm start # or yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

To do a one-off build, use npm run build or yarn build.

To run tests, use npm test or yarn test.

Formatting and linting

Code quality is set up with prettier, husky, and lint-staged.

Jest

Jest tests are set up to run with npm test or yarn test.

Bundle Analysis

size-limit is set up to calculate the real cost of your library with npm run size and visualize the bundle with npm run analyze.

Rollup

TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.

TypeScript

tsconfig.json is set up to interpret dom and esnext types, as well as react for jsx. Adjust according to your needs.

Continuous Integration

GitHub Actions

Two actions are added by default:

• main which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
• size which comments cost comparison of your library on every pull request using size-limit

Optimizations

Please see the main tsdx optimizations docs. In particular, know that you can take advantage of development-only optimizations:

// ./types/index.d.ts
declare var __DEV__: boolean;

// inside your code...
if (__DEV__) {
  console.log('foo');
}

You can also choose to install and use invariant and warning functions.

Module Formats

CJS, ESModules, and UMD module formats are supported.

The appropriate paths are configured in package.json and dist/index.js accordingly. Please report if any issues are found.

Commitlint

We use commmitlint for commit message validation based on Conventional Commits.

Release

Changelog and release management with release-it, using convential changelog.