Dev Utilities

Utilità per lo sviluppo

Update version

Legge la versione registrata in package.json e la aggiorna. Opzionalmente aggiorna anche altri file legati al numero di versione.

Ogni aggiornamento aggiunge una riga al file changelog.txt posizionato sulla root del progetto. Ogni riga contiene la data, la versione aggiornata e opzionalmente un testo descrittivo.

Il numero di versione aggiornato e il testo descrittivo vengono copiati nella clipboard per velocizzare l'inserimento dei commenti dell'eventuale commit successivo.

A partire dalla versione 1.9.x sono gestite anche le versioni di pre-release alpha, beta e rc. Se viene scelto di aggiungere un tag di pre-release si potrà scegliere di associarlo alla major o alla minor version, mentre la patch version viene impostata a 0.

Se un tag pre-release viene rilevato nella versione corrente, si può scegliere, se aggiornarlo, cambiarlo con altro tag (resettando la versione pre-release a 0) o eliminarlo del tutto.

Utilizzo:

node ./node_modules/@massimo-cassandro/dev-utils/scripts/update-version.mjs --config=path/to/config.js

In cui --config=<path> indica il percorso al file .js di configurazione generale (vedi sotto). Il file deve esportare un oggetto con la proprietà updateVersion. Se il path non viene specificato, il percorso di default è ./dev-utils.config.js.

La proprietà updateVersion può contenere:

const config = {
  updateVersion: {
     
    /*
      percorso al file twig che contiene l'array di variabili globali  `glob_vars` che contiene a sua volta l'elemento `vers` che viene impostato col valore assegnato alla proprietà `version` di `packege.json`
      (default null)
    */
    twigVarsFile: 'path/to/file/config.html.twig',

    /*
      cerca la stringa `(?|&)(_|v)=1.2.3(-\d+)` associata ai tag che richiamano file js o css all'interno dei file html specificati e aggiorna il numero di versione
      (default null)
    */
    htmlFiles: ['path/to/html_file1.html', 'path/to/html_file2', ...],

    /*
      testo descrittivo di default mostrato tra le opzioni di aggiornamento
      (default null)
    */
    defaultDescr: 'text',

    /*
      se impostato su `true` non viene mostrato il prompt con la richiesta del testo descrittivo (default false). 
      Questa impostazione può essere sovrascritta dalla presenza del parametro CLI `--skip-descr-prompt`
    */
    skipDescrPrompt: true | false,

    /*
      fa in modo che sia aggiornata direttamente la patch  version saltando l'opzione di scelta relativa (default false). 
      Questa impostazione può essere sovrascritta dalla presenza del parametro CLI `--patch-only`
    */
    patchOnly: true | false

  }
}

Tutti parametri sono opzionali

Parametri CLI

Opzionalmente, e per compatibilità con le versioni precedenti, alcuni parametri possono essere definiti direttamente via CLI:

node ./node_modules/@massimo-cassandro/dev-utils/scripts/update-version.mjs \ 
  --html-files=path/to/html_file1.html,path/to/html_file2.html,... \
  --twig-vars-file=path/to/file/config.html.twig \
  --default-descr=text \
  --skip-descr-prompt \
  --patch-only

I parametri

• --twig-vars-file
• --html-files
• --default-descr

vengono ignorati se il parametro --config è presente, mentre i parametri

• --patch-only
• --skip-descr-prompt

se presenti, prevalgono sulle eventuali impostazioni presenti nel file di configurazione

custom properties list

Estrae dalla lista di file .css indicati l'elenco delle custom properties e genera uno snippet vscode.

Opzionalmente produce anche uno snippet con le icone del progetto vscode.

È necessario predisporre preventivamente gli elementi necessari nel file snippet vscode.

Package json scripts item

{

  "custom props list": {
    "scope": "scss,css,javascript,javascriptreact,js,jsx,styled-css,jsx-attr,html",
    "prefix": ["var("],
    "body": []
  },
  "icons list": {
    "scope": "scss,css,javascript,javascriptreact,js,jsx,styled-css,jsx-attr,html",
    "prefix": ["icon"],
    "body": []
  }
}

File di configurazione

Il file di configurazione di dev-utils permette la definizione dei parametri per tutti script presenti. Nessun parametro è obbligatorio, quelli presenti sono i valori di default:

const config = {
  updateVersion: { 
    wigVarsFile     : null,
    htmlFiles        : null,
    skipDescrPrompt  : false,
    patchOnly        : false,
    defaultDescr     : null
  },
  getCssProps: {/* cfg */}
};

export default config;

Utilizzo nella sezione script del file package.json

Esempio di implementazione:

{
  "scripts": {
     "update-version": "node ./node_modules/@massimo-cassandro/dev-utils/scripts/update-version/index.mjs --config=./dev-utils.config.js"
  }
}

TODO

Update Version

• opzione per non aggiornare html e twig ma solo package.json

custom properties list

• https://github.com/microsoft/node-jsonc-parser