v1.0.1
Um utilitário CLI para compilar múltiplos arquivos SCSS em um único arquivo CSS para evitar a ligação de um milhão de arquivos CSS dentro de um projeto. O Compile SCSS utiliza o Click para construir sua interface CLI.
Installation
pip install compile_scss
Usage
Run compile_scss
Se compile_scss
for executado sem nenhuma opção ou flags, o Compile SCSS procurará no diretório raiz do projeto por um arquivo chamado compile_scss_config.json
, que armazena um objeto JSON com valores de configuração pré-definidos pelo usuário.
Se um arquivo de configuração for encontrado, o Compile SCSS será executado usando a configuração encontrada no arquivo JSON. Se nenhum arquivo de configuração for encontrado, um Read, Evaluate, Print, Loop (R.E.P.L.) será acionado e o usuário terá a opção de definir novos valores de configuração com uma série de prompts.
Options
--root <PROJECT_ROOT_DIRECTORY>
A opção
--root
permite que o usuário especifique o diretório raiz do seu projeto. Compile SCSS irá procurar esse diretório para o arquivocompile_scss_config.json
. >O caminho padrão para o diretório raiz é
./
, que se traduz para qualquer diretório do qualcompile_scss
é chamado.
--set-config
Se a bandeira
--set-config
estiver presente, a configuração R.E.P.L. será acionado por padrão.Se um arquivo de configuração for encontrado, o usuário terá a opção de criar um novo arquivo de configuração ou continuar com os valores encontrados no arquivo de configuração.
Se nenhum arquivo de configuração for encontrado, o usuário terá a opção de criar um novo arquivo de configuração.
--watch
Se o sinalizador
--watch
estiver presente, o Compile SCSS observará o diretório SCSS especificado no arquivo de configuração para quaisquer alterações e atualizará o arquivo CSS de acordo.
Configuração
Por padrão, o Compile SCSS procurará no diretório raiz do projeto por um arquivo chamado compile_scss_config.json
. O arquivo deve estar presente e conter um objeto de configuração válido para que o Compile SCSS seja executado.
O arquivo de configuração deve conter cinco chaves e valores correspondentes:
-
root – O diretório raiz do projeto. O valor padrão para isto é
./
-
scss_dir – O diretório SCSS de nível superior para o projeto. Este diretório pode conter subdiretórios e tantos arquivos SCSS quantos forem necessários. O caminho
scss_dir
deve levar a um diretório contendo pelo menos um arquivo SCSS para ser um caminho SCSS válido. -
css_dir – O diretório CSS contendo o arquivo CSS principal. Aqui é onde o Compile SCSS irá gerar seu arquivo de saída CSS.
-
css_filename – O nome desejado do arquivo CSS alvo.
O nome do arquivo não deve conter caracteres especiais que não sejam hífens ou sublinhados. A extensão do arquivo deve ser minúscula, mas o nome do arquivo pode conter letras maiúsculas.
Veja os exemplos abaixo para nomes de arquivos válidos e inválidos.
-
output_style – Libsass’
sass.compile()
permite que a saída CSS seja compilada em um dos quatro estilos:-
compacto
-
comprimido
-
expandido
-
nested
-
Nomes de arquivos CSS válidos e inválidos
Válido
Inválido
Arquivo de configuração de amostra
{ "root": ".", "scss_dir": "./static/scss", "css_dir": "./static/css", "css_filename": "index.css", "output_style": "expanded"}
Compilar SCSS ainda está em desenvolvimento. Foi testado com sucesso mas não extensivamente com:
- Variáveis
- @Declarações de importação
- Funções (básico)
- Mixins (básico)