@tryghost/algolia-fragmenter 0.2.7 → 0.2.9

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013-2023 Ghost Foundation
+Copyright (c) 2013-2025 Ghost Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,41 +1,44 @@
 # Algolia Fragmenter
 
-Fragment transformer converts a Ghost post into an Algolia Object and breaks down large HTML strings into sensible fragments based on headings.
+`@tryghost/algolia-fragmenter` converts Ghost posts into Algolia records and breaks long HTML into heading-based fragments.
 
 ## Install
 
-`npm install @tryghost/algolia-fragmenter --save`
+```sh
+npm install @tryghost/algolia-fragmenter
+```
 
 or
 
-`yarn add @tryghost/algolia-fragmenter`
-
+```sh
+pnpm add @tryghost/algolia-fragmenter
+```
 
 ## Usage
 
+Convert Ghost Content API posts, then reduce the resulting records into fragments:
 
-## Develop
-
-This is a mono repository, managed with [lerna](https://lernajs.io/).
-
-Follow the instructions for the top-level repo.
-1. `git clone` this repo & `cd` into it as usual
-2. Run `yarn` to install top-level dependencies.
-
-
-## Run
+```js
+const transforms = require('@tryghost/algolia-fragmenter');
 
-- `yarn dev`
+const records = transforms.transformToAlgoliaObject(posts);
+const fragments = records.reduce(transforms.fragmentTransformer, []);
+```
 
+`transformToAlgoliaObject` accepts an optional array of post slugs to exclude as its second argument. `fragmentTransformer` is designed to be passed directly to `Array#reduce`.
 
-## Test
+## Development
 
-- `yarn lint` run just eslint
-- `yarn test` run lint and tests
+Install dependencies from the repository root with `pnpm install`. From the root, run this package's tests and lint checks with:
 
+```sh
+pnpm --filter @tryghost/algolia-fragmenter test
+```
 
+Run the full monorepo suite with `pnpm test`.
 
+---
 
-# Copyright & License
+## Copyright & License
 
-Copyright (c) 2013-2023 Ghost Foundation - Released under the [MIT license](LICENSE).
+Copyright (c) 2013-2026 Ghost Foundation - Released under the [MIT license](LICENSE). Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our [trademark policy](https://ghost.org/trademark/) for info on acceptable usage.

package/lib/transformer.js

@@ -56,12 +56,8 @@ module.exports.fragmentTransformer = (recordAccumulator, node) => {
 
         // TODO: switch this on in verbose mode only
         // // If fragments are too long, we need this to see which fragment it was
-        // console.log(`Created fragment: `, objectID, fragment.url || node.url, fragment.html.length); // eslint-disable-line no-console
 
-        return [
-            ...fragmentAccumulator,
-            {...node, ...fragment, objectID: objectID}
-        ];
+        return [...fragmentAccumulator, {...node, ...fragment, objectID: objectID}];
     }, []);
 
     return [...recordAccumulator, ...records];
@@ -78,7 +74,7 @@ module.exports._testReduceFragmentsUnderHeadings = reduceFragmentsUnderHeadings;
 module.exports.transformToAlgoliaObject = (posts, ignoreSlugs) => {
     const algoliaObjects = [];
 
-    posts.map((post) => {
+    posts.map(post => {
         // Define the properties we need for Algolia
         const algoliaPost = {
             objectID: post.id,
@@ -100,13 +96,13 @@ module.exports.transformToAlgoliaObject = (posts, ignoreSlugs) => {
         }
 
         if (post.tags && post.tags.length) {
-            post.tags.forEach((tag) => {
+            post.tags.forEach(tag => {
                 algoliaPost.tags.push({name: tag.name, slug: tag.slug});
             });
         }
 
         if (post.authors && post.authors.length) {
-            post.authors.forEach((author) => {
+            post.authors.forEach(author => {
                 algoliaPost.authors.push({name: author.name, slug: author.slug});
             });
         }

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@tryghost/algolia-fragmenter",
-  "version": "0.2.7",
-  "repository": "https://github.com/TryGhost/algolia/tree/master/packages/algolia-fragmenter",
+  "version": "0.2.9",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TryGhost/algolia.git",
+    "directory": "packages/algolia-fragmenter"
+  },
   "author": "Ghost Foundation",
   "license": "MIT",
-  "main": "index.js",
-  "scripts": {
-    "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing mocha './test/**/*.test.js'",
-    "lint": "eslint . --ext .js --cache",
-    "posttest": "yarn lint"
+  "engines": {
+    "node": ">=24"
   },
+  "main": "index.js",
   "files": [
     "index.js",
     "lib"
@@ -18,13 +19,13 @@
   "publishConfig": {
     "access": "public"
   },
-  "devDependencies": {
-    "mocha": "10.2.0",
-    "should": "13.2.3",
-    "sinon": "17.0.0"
-  },
   "dependencies": {
     "algolia-html-extractor": "0.0.1"
   },
-  "gitHead": "0f5dd82ecdabe8ae3d7153c7476472b08ce8732a"
-}
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test": "NODE_ENV=testing vitest run --root .",
+    "lint": "oxlint --quiet . && oxfmt --check .",
+    "posttest": "pnpm lint"
+  }
+}