Add option to customize config in a toolkit.config.js file instead of package.json
Nessuno ha ancora preso questa issue.
- #188 di @kmcaloon — chiusa senza merge
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 30/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- javascript
- Ambito
- build-system
Direzione di ricerca
Inizia in utils/config.js, da getTenUpScriptsConfig(), quindi esamina come package.json, filenames.config.js e un webpack.config.js personalizzato forniscono attualmente la configurazione. Definisci il comportamento previsto di toolkit.config.js e verifica che le entry dinamiche raggiungano il resto del processo di build senza perdere la configurazione predefinita esistente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Is your enhancement related to a problem? Please describe.
I was wondering what is behind the choice of allowing developers to modify the toolkit configuration via package.json and filenames.config.js instead of having something like a toolkit.config.js at the project root?
For my specific use case, I am trying to implement dynamic entries but modifying just the entry within a custom webpack config isn't enough because other functions throughout the build process rely on getTenUpScriptsConfig() to return the entries. Maybe there might be other use cases where it would be handy having the entire toolkit configuration customizable with js?
I didn't want to create a PR because I'm sure you have your reasons for the current structure, but I am able to easily accomplish what I'm looking for by making the following change to utils/config.js:
/**
* Returns 10up-scripts config either from package.json or toolkit.config.js with default values
*
* @returns {object}
*/
const getTenUpScriptsConfig = () => {
const packageJson = getPackage();
const configJS = 'toolkit.config.js';
const config = packageJson['10up-toolkit'] || packageJson['@10up/scripts'] || hasProjectFile(configJS) && require(fromProjectRoot(configJS));
const defaultConfig = getDefaultConfig();
if (!config) {
return defaultConfig;
}
return {
// override default configs with user-defined config
...defaultConfig,
...config,
// these properties must be merged
filenames: {
...defaultConfig.filenames,
...config.filenames,
},
paths: {
...defaultConfig.paths,
...config.paths,
},
};
};
Designs
No response
Describe alternatives you've considered
As mentioned, I've also tried modifying a custom webpack.config.js at the project root but it doesn't allow for the dynamic entries to be piped into the rest of the build process.
Code of Conduct
- I agree to follow this project's Code of Conduct
- Lingua principale
- JavaScript
- Stelle
- 147
- Fork
- 21
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di 10up/10up-toolkit
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
10up/10up-toolkit#486 · 1 commento · 1 reazione ·
-
Toolkit Future PlanningForse di nuovo libera @fabiankaegy l’ha presa 190 giorni fa e non c’è nessuna pull request aperta. Aperta[Type] Tracking Issue
10up/10up-toolkit#489 · 7 commenti · 2 reazioni · 1 assegnatario ·
-
CSS
Difficoltà 3/5 1-2 giorni Idoneità per principianti 58/100
10up/10up-toolkit#487 · 3 commenti ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
10up/10up-toolkit#482 ·
-
`10up-toolkit test-unit-jest` command does not work out of the boxForse già presa Una pull request collegata a questa issue è aperta o già unita. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 45/100
10up/10up-toolkit#480 ·
Tutte le issue di 10up/10up-toolkit
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
-
needs discussion
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
openfga/openfga.dev#1436 · 1 commento ·
I maintainer di solito rispondono entro 2 giorni
-
Add Aurex BrowserAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 78/100
ImranR98/apps.obtainium.imranr.dev#2018 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
521xueweihan/HelloGitHub#4416 ·
-
type: bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 2 giorni