From f67c5357463866494eee59ae0e59ad64c6f3b4a0 Mon Sep 17 00:00:00 2001 From: Cameron Date: Tue, 27 Feb 2024 16:56:25 -0500 Subject: [PATCH] remove repocloner, use install script --- docpad.coffee | 23 --- package-lock.json | 274 ++++------------------------ package.json | 3 +- scripts/install-flixel-docs-repo.js | 24 +++ 4 files changed, 66 insertions(+), 258 deletions(-) create mode 100644 scripts/install-flixel-docs-repo.js diff --git a/docpad.coffee b/docpad.coffee index eb9360682..7b0284a7e 100644 --- a/docpad.coffee +++ b/docpad.coffee @@ -1,6 +1,5 @@ # For the blog preview page parse the markdown with github flavour. removeMd = require 'remove-markdown' -backers = require './src/files/backers.json' # The DocPad Configuration File @@ -47,10 +46,6 @@ docpadConfig = { # ----------------------------- # Helper Functions - # Used in the fundraiser page for the indiegogo backer list - getBackers: -> - backers - # Get the prepared site/document title # Often we would like to specify particular formatting to our page's title # we can apply that formatting here @@ -121,15 +116,6 @@ docpadConfig = { collections: - blog: (database) -> - database.findAllLive({layout:$has:['blog-post', 'fundraiser-layout']}, [filename:-1]).on 'add', (document) -> - a = document.attributes - if a.layout != "fundraiser-layout" - contentPreview = removeMd(a.content).substring(0,150) + " ..." - document.setMetaDefaults({ - contentPreview - }) - getting_started: (database) -> docpadConfig.templateData.getDocCollection(database, '00_getting_started', 'getting_started', 'Getting Started') @@ -176,15 +162,6 @@ docpadConfig = { enabled: true markedOptions: gfm: true - - repocloner: - repos: [ - { - name: 'HaxeFlixelDocumentation' - path: 'src/documents/documentation' - url: 'https://github.com/HaxeFlixel/flixel-docs.git' - } - ] } # Export our DocPad Configuration diff --git a/package-lock.json b/package-lock.json index 4551ddae4..0bf5658fd 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,6 +7,7 @@ "": { "name": "haxeflixel.com", "version": "0.2.0", + "hasInstallScript": true, "dependencies": { "docpad": "6.79.x", "docpad-plugin-cleanurls": "2.11.0", @@ -15,7 +16,6 @@ "docpad-plugin-less": "2.5.1", "docpad-plugin-marked": "2.4.0", "docpad-plugin-partials": "2.12.0", - "docpad-plugin-repocloner": "2.3.1", "remove-markdown": "github:stiang/remove-markdown#main", "sharp": "^0.33.2" }, @@ -23,6 +23,7 @@ "@11ty/eleventy": "^2.0.1", "@11ty/eleventy-img": "^4.0.2", "npm-run-all2": "^6.1.2", + "shelljs": "^0.8.5", "standard": "^17.1.0" } }, @@ -2909,239 +2910,6 @@ "url": "https://bevry.me/fund" } }, - "node_modules/docpad-plugin-repocloner": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/docpad-plugin-repocloner/-/docpad-plugin-repocloner-2.3.1.tgz", - "integrity": "sha512-F8sEAAtlAjPLxktvHGhT2YfRuCQt1I/+RDstBsbvkWD6U+UtcUnSQqBrZVEYm85QXjS7V3FWKbU2KtHi0Luw0g==", - "dependencies": { - "extendr": "^3.2.2", - "safeps": "^7.0.1", - "taskgroup": "^5.0.1" - }, - "engines": { - "node": ">=0.12" - }, - "peerDependencies": { - "docpad": ">=6.46 <7" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/ambi": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/ambi/-/ambi-3.2.0.tgz", - "integrity": "sha512-nj5sHLPFd7u2OLmHdFs4DHt3gK6edpNw35hTRIKyI/Vd2Th5e4io50rw1lhmCdUNO2Mm4/4FkHmv6shEANAWcw==", - "dependencies": { - "editions": "^2.1.0", - "typechecker": "^4.3.0" - }, - "engines": { - "node": ">=0.8" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/ambi/node_modules/editions": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/editions/-/editions-2.3.1.tgz", - "integrity": "sha512-ptGvkwTvGdGfC0hfhKg0MT+TRLRKGtUiWGBInxOm5pz7ssADezahjCUaYuZ8Dr+C05FW0AECIIPt4WBxVINEhA==", - "dependencies": { - "errlop": "^2.0.0", - "semver": "^6.3.0" - }, - "engines": { - "node": ">=0.8" - }, - "funding": { - "url": "https://bevry.me/fund" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/eachr": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/eachr/-/eachr-3.3.0.tgz", - "integrity": "sha512-yKWuGwOE283CTgbEuvqXXusLH4VBXnY2nZbDkeWev+cpAXY6zCIADSPLdvfkAROc0t8S4l07U1fateCdEDuuvg==", - "dependencies": { - "editions": "^2.2.0", - "typechecker": "^4.9.0" - }, - "engines": { - "node": ">=0.10" - }, - "funding": { - "url": "https://bevry.me/fund" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/eachr/node_modules/editions": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/editions/-/editions-2.3.1.tgz", - "integrity": "sha512-ptGvkwTvGdGfC0hfhKg0MT+TRLRKGtUiWGBInxOm5pz7ssADezahjCUaYuZ8Dr+C05FW0AECIIPt4WBxVINEhA==", - "dependencies": { - "errlop": "^2.0.0", - "semver": "^6.3.0" - }, - "engines": { - "node": ">=0.8" - }, - "funding": { - "url": "https://bevry.me/fund" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/errlop": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/errlop/-/errlop-2.2.0.tgz", - "integrity": "sha512-e64Qj9+4aZzjzzFpZC7p5kmm/ccCrbLhAJplhsDXQFs87XTsXwOpH4s1Io2s90Tau/8r2j9f4l/thhDevRjzxw==", - "engines": { - "node": ">=0.8" - }, - "funding": { - "url": "https://bevry.me/fund" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/extendr": { - "version": "3.5.0", - "resolved": "https://registry.npmjs.org/extendr/-/extendr-3.5.0.tgz", - "integrity": "sha512-7zpVbnnZy91J4k916ZGwpys56DEgJc/prTXDiqCYe/Mud5pqdVsSc9mG/U6sz3lQEvHs81i8Zi7whsFwifhZyw==", - "dependencies": { - "editions": "^2.2.0", - "typechecker": "^4.7.0" - }, - "engines": { - "node": ">=0.12" - }, - "funding": { - "type": "cooperative", - "url": "https://bevry.me/fund" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/extendr/node_modules/editions": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/editions/-/editions-2.3.1.tgz", - "integrity": "sha512-ptGvkwTvGdGfC0hfhKg0MT+TRLRKGtUiWGBInxOm5pz7ssADezahjCUaYuZ8Dr+C05FW0AECIIPt4WBxVINEhA==", - "dependencies": { - "errlop": "^2.0.0", - "semver": "^6.3.0" - }, - "engines": { - "node": ">=0.8" - }, - "funding": { - "url": "https://bevry.me/fund" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/safefs": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/safefs/-/safefs-4.2.0.tgz", - "integrity": "sha512-1amPBO92jw/hWS+gH/u7z7EL7YxaJ8WecBQl49tMQ6Y6EQfndxNNKwlPqDOcwpUetdmK6nKLoVdjybVScRwq5A==", - "dependencies": { - "editions": "^2.2.0", - "graceful-fs": "^4.2.3" - }, - "engines": { - "node": ">=0.12" - }, - "funding": { - "type": "cooperative", - "url": "https://bevry.me/fund" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/safefs/node_modules/editions": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/editions/-/editions-2.3.1.tgz", - "integrity": "sha512-ptGvkwTvGdGfC0hfhKg0MT+TRLRKGtUiWGBInxOm5pz7ssADezahjCUaYuZ8Dr+C05FW0AECIIPt4WBxVINEhA==", - "dependencies": { - "errlop": "^2.0.0", - "semver": "^6.3.0" - }, - "engines": { - "node": ">=0.8" - }, - "funding": { - "url": "https://bevry.me/fund" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/safeps": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/safeps/-/safeps-7.0.1.tgz", - "integrity": "sha512-aFREKZzceHZH3KZTwjhDI1oOOcyAEBcQHjImJS/Mmx+KC31EQCgwiPKfwhJLBX7R4Y5ioI2D/VEcQ6U6ya2MJw==", - "dependencies": { - "editions": "^1.3.3", - "extract-opts": "^3.3.1", - "safefs": "^4.1.0", - "taskgroup": "^5.0.0", - "typechecker": "^4.3.0" - }, - "engines": { - "node": ">=0.8" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/taskgroup": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/taskgroup/-/taskgroup-5.5.0.tgz", - "integrity": "sha512-YFkdc6HU+p3xO2lZ1MWdx7R7EbrLF/bpXv5k9635bTzdgOLNbmnsDg5alSpZost+PYMk40d6ZDAJHBHNHiiLvw==", - "dependencies": { - "ambi": "3.2.0", - "eachr": "^3.2.0", - "editions": "^2.2.0", - "extendr": "^3.5.0", - "safeps": "7.0.1", - "unbounded": "^1.2.0" - }, - "engines": { - "node": ">=0.8" - }, - "funding": { - "type": "cooperative", - "url": "https://bevry.me/fund" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/taskgroup/node_modules/editions": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/editions/-/editions-2.3.1.tgz", - "integrity": "sha512-ptGvkwTvGdGfC0hfhKg0MT+TRLRKGtUiWGBInxOm5pz7ssADezahjCUaYuZ8Dr+C05FW0AECIIPt4WBxVINEhA==", - "dependencies": { - "errlop": "^2.0.0", - "semver": "^6.3.0" - }, - "engines": { - "node": ">=0.8" - }, - "funding": { - "url": "https://bevry.me/fund" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/typechecker": { - "version": "4.11.0", - "resolved": "https://registry.npmjs.org/typechecker/-/typechecker-4.11.0.tgz", - "integrity": "sha512-lz39Mc/d1UBcF/uQFL5P8L+oWdIn/stvkUgHf0tPRW4aEwGGErewNXo2Nb6We2WslWifn00rhcHbbRWRcTGhuw==", - "dependencies": { - "editions": "^2.2.0" - }, - "engines": { - "node": ">=0.8" - }, - "funding": { - "url": "https://bevry.me/fund" - } - }, - "node_modules/docpad-plugin-repocloner/node_modules/typechecker/node_modules/editions": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/editions/-/editions-2.3.1.tgz", - "integrity": "sha512-ptGvkwTvGdGfC0hfhKg0MT+TRLRKGtUiWGBInxOm5pz7ssADezahjCUaYuZ8Dr+C05FW0AECIIPt4WBxVINEhA==", - "dependencies": { - "errlop": "^2.0.0", - "semver": "^6.3.0" - }, - "engines": { - "node": ">=0.8" - }, - "funding": { - "url": "https://bevry.me/fund" - } - }, "node_modules/docpad/node_modules/mime": { "version": "1.6.0", "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", @@ -5424,6 +5192,15 @@ "node": ">= 0.4" } }, + "node_modules/interpret": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz", + "integrity": "sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, "node_modules/ipaddr.js": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.0.5.tgz", @@ -7865,6 +7642,18 @@ "node": ">=8.10.0" } }, + "node_modules/rechoir": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz", + "integrity": "sha512-HFM8rkZ+i3zrV+4LQjwQ0W+ez98pApMGM3HUrN04j3CqzPOzl9nmP15Y8YXNm8QHGv/eacOVEjqhmWpkRV0NAw==", + "dev": true, + "dependencies": { + "resolve": "^1.1.6" + }, + "engines": { + "node": ">= 0.10" + } + }, "node_modules/recursive-copy": { "version": "2.0.14", "resolved": "https://registry.npmjs.org/recursive-copy/-/recursive-copy-2.0.14.tgz", @@ -8548,6 +8337,23 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/shelljs": { + "version": "0.8.5", + "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.5.tgz", + "integrity": "sha512-TiwcRcrkhHvbrZbnRcFYMLl30Dfov3HKqzp5tO5b4pt6G/SezKcYhmDg15zXVBswHmctSAQKznqNW2LO5tTDow==", + "dev": true, + "dependencies": { + "glob": "^7.0.0", + "interpret": "^1.0.0", + "rechoir": "^0.6.2" + }, + "bin": { + "shjs": "bin/shjs" + }, + "engines": { + "node": ">=4" + } + }, "node_modules/side-channel": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.5.tgz", diff --git a/package.json b/package.json index f92b3f691..036e86b8b 100644 --- a/package.json +++ b/package.json @@ -14,12 +14,12 @@ "docpad-plugin-less": "2.5.1", "docpad-plugin-marked": "2.4.0", "docpad-plugin-partials": "2.12.0", - "docpad-plugin-repocloner": "2.3.1", "remove-markdown": "github:stiang/remove-markdown#main", "sharp": "^0.33.2" }, "main": "node_modules/docpad/bin/docpad-server", "scripts": { + "preinstall": "node scripts/install-flixel-docs-repo.js", "start": "run-s start:*", "start:11ty": "eleventy", "start:docpad": "docpad run", @@ -33,6 +33,7 @@ "@11ty/eleventy": "^2.0.1", "@11ty/eleventy-img": "^4.0.2", "npm-run-all2": "^6.1.2", + "shelljs": "^0.8.5", "standard": "^17.1.0" }, "standard": { diff --git a/scripts/install-flixel-docs-repo.js b/scripts/install-flixel-docs-repo.js new file mode 100644 index 000000000..e7c972e1c --- /dev/null +++ b/scripts/install-flixel-docs-repo.js @@ -0,0 +1,24 @@ +const shell = require('shelljs') +const { execSync } = require('child_process') + +console.log('Installing flixel-docs...') +console.log('Current folder: ' + shell.pwd().stdout) + +if (!shell.which('git')) { + shell.echo('Sorry, this script requires git') + shell.exit(1) +} + +const path = './src/documents/documentation' + +if (shell.test('-e', path + '/.git')) { + console.log('Updating flixel-docs...') + shell.cd(path) + execSync('git fetch --all') + + const pullstdout = execSync('git pull') + console.log(pullstdout.toString()) +} else { + console.log('Cloning flixel-docs to ' + path + '...') + execSync('git clone --depth 1 --no-single-branch https://github.com/haxeflixel/flixel-docs ' + path) +}