@thegetty/quire-cli 1.0.0-rc.35 → 1.0.0-rc.37

package/src/commands/conf.js

@@ -1,43 +0,0 @@
-import Command from '#src/Command.js'
-
-/**
- * Quire CLI `conf` Command
- *
- * @class      ConfCommand
- * @extends    {Command}
- */
-export default class ConfCommand extends Command {
-  static definition = {
-    name: 'conf',
-    aliases: ['config', 'configure'],
-    description: 'Manage the Quire CLI configuration.',
-    summary: 'read/write quire-cli configuration options',
-    version: '1.0.0',
-    options: [
-      [ '--debug', 'run command in debug mode' ],
-    ],
-  }
-
-  constructor() {
-    super(ConfCommand.definition)
-  }
-
-  /**
-   * @param      {Object}  options
-   * @return     {Promise}
-   */
-  async action(key, value, options = {}) {
-    if (options.debug) {
-      console.info('Command \'%s\' called with options %o', this.name(), options)
-    }
-
-    // this.outputHelp()
-
-    console.info('quire-cli configuration %s', this.config.path)
-
-    for (const [ key, value ] of Object.entries(this.config.store)) {
-      if (key.startsWith('__internal__') && !options.debug) continue
-      console.info('%s: %O', key, value)
-    }
-  }
-}

package/src/commands/version.js

@@ -1,43 +0,0 @@
-import Command from '#src/Command.js'
-import { paths, projectRoot  } from '#lib/11ty/index.js'
-import * as quire from '#lib/quire/index.js'
-import testcwd from '#helpers/test-cwd.js'
-
-/**
- * Quire CLI `version` Command
- *
- * Running `quire version` sets the `quire-11ty` version for a project.
- * The version is written to a `.quire` file in the project directory
- * or to the `quire-cli` package `.quire` when the `global` flag is used.
- *
- * @class      VersionCommand
- * @extends    {Command}
- */
-export default class VersionCommand extends Command {
-  static definition = {
-    name: 'version',
-    description: 'Sets the Quire version to use when running commands on the project.',
-    summary: 'set the @thegetty/quire-11ty version',
-    version: '1.0.0',
-    args: [
-      [ '<version>', 'the local quire version to use' ],
-    ],
-    options: [
-      // [ '-g', '--global', 'set the quire version globally' ],
-    ],
-  }
-
-  constructor() {
-    super(VersionCommand.definition)
-  }
-
-  action(args, options = {}) {
-    if (options.debug) {
-      console.info('Command \'%s\' called with options %o', this.name, options)
-    }
-  }
-
-  preAction(command) {
-    testcwd(command)
-  }
-}

package/src/lib/11ty/paths.js

@@ -1,103 +0,0 @@
-import { fileURLToPath } from 'node:url'
-import fs from 'fs-extra'
-import path from 'node:path'
-
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-
-/**
- * Eleventy configuration paths
- * @see https://www.11ty.dev/docs/config/#configuration-options
- *
- * Resolve the absolute path to the Eleventy configuration module,
- * `eleventyRoot` is _relative_ to `main.js`, the CLI entry point.
- * Both `input` and `output` are _relative_ to the `config` module.
- *
- * @todo
- * - refactor the paths module as a concern of the `lib/quire` module
- * - refactor resolving an absolute path to the correct eleventy version root;
- *   this needs to use the correct `quire-11ty` version for the project
- *   and correctly resolve the path to the target of the 'latest' symlink
- */
-const cliRoot = path.resolve(__dirname, path.join('..', '..'))
-const eleventyConfig = '.eleventy.js'
-const version = 'latest'
-
-export const projectRoot = process.cwd()
-
-/**
- * Absolute path to the latest installed version of `quire-11ty`
- * @todo use version read from the project `.quire-version` file
- */
-const libQuirePath = path.resolve(__dirname, path.join(cliRoot, 'lib', 'quire', 'versions', version))
-
-/**
- * Absolute path to the current version of `quire-11ty`
- * Nota bene: to get a relative path to the `eleventyRoot`,
- * for example when the version is specified is 'latest',
- * it must be set to the real path to the symlink target.
- *
- * @todo refactor how and *when* the eleventyRoot is determined:
- *  - we only need eleventyRoot for cli commands that run 11ty
- *  - paths module is a concern of the `quire` module
- *  - global quire-cli installation
- *  - local quire-cli installation
- *
- *  For an excellent developer experience, the quire-11ty code should be
- *  installed into an `11ty` or `quire-11ty` directory in the `projectRoot`
- *  this will allow us to more easily manage symlinks for local development
- *  using unpublished `quire-11ty` code.
- *  @example
- *  ```sh
- *  blargh/
- *    .git/
- *    .gitignore
- *    .node-version
- *    .quire-version
- *    11ty@ --> /Users/mph/Code/Getty/quire/packages/11ty
- *    content/
- *    CHANGELOG.md
- *    LICENSE
- *    README.md
- *    package.json
- *    package-lock.json
- *  ```
- *  Installing to a directory will allow more cleanly `eject` and `uneject`
- *  using a symlink or single directory `rm -rf`.
- *  Should the `11ty` directory be a dot directory to hide the complexity from
- *  users or should it be visible to be more explicit when project is ejected?
- */
-const getEleventyRoot = () => {
-  // try {
-  //   return fs.readdirSync(projectRoot).includes(eleventyConfig)
-  //     ? projectRoot
-  //     : fs.realpathSync(libQuirePath)
-  // } catch (error) {
-  //   throw new Error(`[CLI:11ty] Unable to read project directory for eleventy config ${error}`)
-  // }
-  return projectRoot
-}
-
-export const eleventyRoot = getEleventyRoot()
-
-const inputDir = path.join(projectRoot, 'content')
-
-export default {
-  /**
-   * An abolsute path to eleventy config module
-   */
-  config: path.join(eleventyRoot, '.eleventy.js'),
-  /**
-   * Paths _relative to_ the eleventy config module
-   */
-  input: path.relative(eleventyRoot, inputDir),
-  output: path.relative(eleventyRoot, path.join(projectRoot, '_site')),
-  epub: path.relative(eleventyRoot, path.join(projectRoot, '_epub')),
-  /**
-   * Paths _relative to_ the `input` directory
-   */
-  data: '_computed',
-  includes: path.relative(inputDir, path.join(eleventyRoot, '_includes')),
-  layouts: path.relative(inputDir, path.join(eleventyRoot, '_layouts')),
-  public: './public',
-}

package/src/lib/i18n/README.md

@@ -1,3 +0,0 @@
-## CLI Internationalization (i18n) & Localization Module
-
-This `quire-cli/lib/i18n` module manages localized message strings for the `quire-cli` and implements a façade for a separate i18n service.

package/src/lib/i18n/config.js

@@ -1,53 +0,0 @@
-/**
- * i18next configuration
- * @see https://www.i18next.com/overview/configuration-options
- *
- * @todo
- * set debug using cli `--debug` option
- * set resources by loading data files
- */
-const configuration = {
-  debug: true,
-  /**
-   * Languages
-   */
-  fallbackLng: 'en',
-  lng: 'en',
-  supportedLngs: ['en'],
-  /**
-   * Namespaces
-   */
-  defaultNS: 'translation',
-  fallbackNS: false,
-  ns: 'translation',
-  /**
-   * Resources
-   */
-  partialBundledLanguages: false,
-  resources: {
-    en: {
-      translation: {
-        'gradoo': 'blargh',
-      }
-    },
-  },
-  /**
-   * Missing Keys
-   * @ https://www.i18next.com/overview/configuration-options#missing-keys
-   */
-  saveMissing: false,
-  /**
-   * Translation defaults
-   * @ https://www.i18next.com/overview/configuration-options#translation-defaults
-   */
-
-  /**
-   * Plugin options
-   * @see https://www.i18next.com/overview/configuration-options#plugin-options
-   */
-
-  /**
-   * Other
-   * @see https://www.i18next.com/overview/configuration-options#others
-   */
-}

package/src/lib/i18n/index.js

@@ -1,43 +0,0 @@
-import { LocaleService } from './LocaleService.js'
-import I18nextCLILanguageDetector from 'i18next-cli-language-detector'
-import i18next from 'i18next'
-
-/**
- * i18next configuration
- * @see https://www.i18next.com/overview/configuration-options
- *
- * @todo
- * set debug using cli `--debug` option
- * set resources by loading data files
- */
-const configuration = {
-  debug: true,
-  /**
-   * Languages
-   */
-  fallbackLng: 'en',
-  lng: 'en',
-  supportedLngs: ['en'],
-  /**
-   * Namespaces
-   */
-  defaultNS: 'translation',
-  fallbackNS: false,
-  ns: 'translation',
-  /**
-   * Resources
-   */
-  resources: {
-    en: {
-      translation: {
-        'gradoo': 'blargh',
-      }
-    },
-  },
-}
-
-await i18next
-  .use(I18nextCLILanguageDetector)
-  .init(configuration)
-
-export default new LocaleService(i18next)

package/src/lib/i18n/localeService.js

@@ -1,58 +0,0 @@
-/**
- * Localization service
- *
- * @class  LocaleService
- */
-export class LocaleService {
-  /**
-   * @param  {Object}  i18nProvider
-   */
-  constructor(i18nProvider) {
-    this.i18nProvider = i18nProvider
-  }
-
-  /**
-   * Gets the current locale
-   *
-   * @return  {String}  current locale code
-   */
-  getCurrentLocale() {
-    return this.i18nProvider.getLocale()
-  }
-
-  /**
-   * Get a list of supported locales
-   *
-   * @return {Array}  List of supported locale codes
-   */
-  getLocales() {
-    return this.i18nProvider.getLocales()
-  }
-
-  /**
-   * Sets the current locale
-   *
-   * @param  {String}  locale  i18n locale code
-   * @return  {String}  the current locale code
-   */
-  setLocale(locale) {
-    const locales = this.getLocales()
-    if (!locales.includes(locale)) {
-      throw new Error(`
-        Unknown locale code ${locale} Unable to set current locale;
-        supported locales: ${locales}
-      `)
-    }
-    return this.i18nProvider.setLocale(locale)
-  }
-
-  /**
-   * Translate a string
-   *
-   * @param  {String}  string   string to translate
-   * @param  {Object}  options  translation options
-   */
-  translate(string, options) {
-    return this.i18nProvider.t(string)
-  }
-}

package/src/lib/quire/README.md

@@ -1,19 +0,0 @@
-## CLI Quire Module
-
-The primary concern of the Quire CLI `quire` module is to decouple the `11ty` package from the publication content templates and manage the version of the [Quire/11ty package](packages/11ty) that is used to build a Quire project.
-
-The [Quire/11ty package](packages/11ty) contains the Eleventy [configuration](packages/11ty/.eleventy.js), [includes](packages/11ty/_includes), [layouts](packages/11ty/_layouts), and [plugins](packages/11ty/_plugins) for [universal template shortcodes](packages/11ty/_plugins/shortcodes) and [components](packages/11ty/_includes/components) to build Quire publications.
-
-When the Quire CLI is installed the latest version of the [11ty package](packages/11ty) is installed in in the `cli/quire/versions/` directory.
-
-```sh
-cli/
-  quire/
-    versions/
-      1.0.0/
-        _includes/
-        _layouts/
-        _plugins/
-        .eleventy.js
-        package.json
-```