@guardian/libs

@guardian/libs

A collection of JavaScript libraries for Guardian projects

Table of contents

• Libs
  • getLocale
  • isString
  • isUndefined
  • loadScript
  • log/debug
  • storage
  • cookies
  • timeAgo
• Installation
  • Bundling
• Development
  • Requirements
  • Releasing

Libs

The following modules are available:

getLocale

Get the user’s current location.

isString

Check whether a value is a string.

isUndefined

Check whether a value is undefined.

loadScript

Inject an external JavaScript file.

log/debug

Selectively log team-specific messages to the console.

storage

Robust API over localStorage and sessionStorage.

cookies

API over document.cookies.

timeAgo

Turns absolute dates into time ago strings.

Installation

yarn add @guardian/libs

or

npm install @guardian/libs

then

import { loadScript, storage, ...etc } from '@guardian/libs';

or

<script src="https://unpkg.com/@guardian/libs"></script>
<script>
    // window.gu.libs = { loadScript, storage, ...etc }
</script>

Bundling

This package uses ES2020.

If your target environment does not support that, make sure you transpile this package when bundling your application.

Development

Requirements

1. Node LTS (latest) (nvm or fnm recommended)
2. Yarn

Releasing

Changes are automatically released to NPM.

The main branch on GitHub is analysed by semantic-release after every push.

If a commit message follows the conventional commit format, semantic-release can determine what Types of changes are included in that commit.

If necessary, it will then automatically release a new, semver-compliant version of the package to NPM.

Pull requests

Try to write PR titles in the conventional commit format, and squash and merge when merging. That way your PR will trigger a release when you merge it (if necessary).