Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add prettier #57

Merged
merged 5 commits into from
Jun 30, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
content
exampleSite/content
layouts
static

package.json
public
node_modules

.DS_Store
logs
*.log
29 changes: 10 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
# Contributing

First off, thank you for your time and effort! This project is not very large and easy to jump into.

## Development stack

- Built with [Hugo](https://gohugo.io/) 🔥
- [Gulp](https://gulpjs.com/) as a build tool 🍹
- Styles in [Stylus](http://stylus-lang.com/) 💅🏻
- [Yarn](https://yarnpkg.com/) as a package manager 📦
First off, thank you for your time and effort! This project is not very large
and easy to jump into.

## Getting started

Expand All @@ -22,30 +16,27 @@ yarn install

## Scripts

There are 3 npm scripts that can be used for development purposes:

```bash
yarn develop
```

This command will start a hugo webserver and serve the `exampleSite`. This works well because the example site uses `hugo-theme-codex`, so any changes
we make to the codebase can be viewed in real time.
Triggers a one-time build of the static directory.

```bash
yarn watch:assets
yarn format
```

If you are working with `js` or `css` you will probably want to run this command in a separate tab from `yarn develop` so that any changes to assets like javascript and css will trigger a re-build by `gulp``.
Runs prettier on the entire project directory.

```bash
yarn build:assets
```
## Assets

Triggers a one-time build of the static directory.
The `assets/` directory is where you can write JS and SCSS, which get processed
into CSS files before being placed in the `static/` directory.

## Questions

If you have any questions feel free to reach out to me directly. Best ways to contact me:
If you have any questions feel free to reach out to me directly. Best ways to
contact me:

- Twitter: https://twitter.com/jakewies
- Email: jakewiesler@gmail.com
13 changes: 6 additions & 7 deletions assets/scss/_main.scss
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
@import 'partials/normalize';
@import 'partials/vars';
@import 'partials/reset';
@import 'partials/typography';
@import 'partials/nav';
@import 'partials/social-icons';
@import "partials/normalize";
@import "partials/vars";
@import "partials/reset";
@import "partials/typography";
@import "partials/nav";
@import "partials/social-icons";

body.nav--active {
overflow: hidden;
Expand All @@ -12,7 +12,6 @@ body.nav--active {
main {
padding: 3rem 1.5rem;


@media screen and (min-width: $medium) {
padding-left: calc(1.5rem + #{$navWidth});
}
Expand Down
2 changes: 1 addition & 1 deletion assets/scss/pages/about.scss
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@import '../main';
@import "../main";

.splash-container {
height: 100%;
Expand Down
6 changes: 3 additions & 3 deletions assets/scss/pages/posts.scss
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
@import '../main';
@import '../partials/post-list';
@import "../main";
@import "../partials/post-list";

.tags__list {
list-style: none;
Expand Down Expand Up @@ -40,7 +40,7 @@
font-size: 0.9rem;

&::before {
content: '#';
content: "#";
font-size: 0.7rem;
padding-right: 1px;
}
Expand Down
7 changes: 4 additions & 3 deletions assets/scss/pages/tags.scss
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
@import '../main';
@import '../partials/post-list';
@import "../main";
@import "../partials/post-list";

.tag__header {
align-items: baseline;
display: flex;
margin: 0 auto 3rem;

a, .separator {
a,
.separator {
color: $grey;
font-size: 1.5rem;
}
Expand Down
8 changes: 4 additions & 4 deletions assets/scss/partials/_colors.scss
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
$black: #111;
$lightGrey: #F7F7F7;
$greyTableBorder: #EEEEEE;
$grey: #9B9B9B;
$lightGrey: #f7f7f7;
$greyTableBorder: #eeeeee;
$grey: #9b9b9b;
$darkGrey: #717171;
$white: #fff;
$primary: #9013FE;
$primary: #9013fe;
7 changes: 5 additions & 2 deletions assets/scss/partials/_github-syntax-highlighting.scss
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ pre[class*="language-"] {
color: #032f62;
}

.language-jsx span[class="comment"]{
.language-jsx span[class="comment"] {
color: pink;
}

Expand All @@ -91,7 +91,10 @@ pre[class*="language-"] {
}

.language-html .token.tag .token.attr-value,
.language-html .token.tag .token.attr-value .token.punctuation:not(:first-child) {
.language-html
.token.tag
.token.attr-value
.token.punctuation:not(:first-child) {
color: #032f62;
}

Expand Down
3 changes: 1 addition & 2 deletions assets/scss/partials/_nav.scss
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@import 'burger';
@import "burger";

.nav {
font-size: 16px;
Expand Down Expand Up @@ -35,7 +35,6 @@
width: auto;
}


@media screen and (max-width: $medium - 1) {
transform: translateY(-25px);
opacity: 0;
Expand Down
4 changes: 2 additions & 2 deletions assets/scss/partials/_normalize.scss
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ button[type="submit"] {
}

input,
input[type=text],
input[type=email] {
input[type="text"],
input[type="email"] {
-webkit-appearance: none;
-moz-appearance: none;
appearance: none;
Expand Down
7 changes: 5 additions & 2 deletions assets/scss/partials/_reset.scss
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
@import "colors";

html, body {
html,
body {
background-color: $white;
color: $black;
height: 100%;
Expand All @@ -10,7 +11,9 @@ html {
box-sizing: border-box;
}

*, *:before, *:after {
*,
*:before,
*:after {
padding: 0;
margin: 0;
box-sizing: inherit;
Expand Down
2 changes: 1 addition & 1 deletion assets/scss/partials/_social-icons.scss
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
height: 1.2rem;
background-size: contain;
background-repeat: no-repeat;

&:not(:last-child) {
margin-right: 2em;
}
Expand Down
29 changes: 17 additions & 12 deletions assets/scss/partials/_typography.scss
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ $scale: 1.414;
$leading: $baseLineHeight * 1rem;

html {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
-webkit-font-smoothing: antialiased;
font-size: 95%;

Expand All @@ -20,7 +21,12 @@ html {
}
}

h1, h2, h3, h4, h5, h6 {
h1,
h2,
h3,
h4,
h5,
h6 {
margin-top: $leading;
margin-bottom: 0;
line-height: $leading;
Expand Down Expand Up @@ -74,32 +80,31 @@ ol {
blockquote {
&::before {
position: absolute;
content: '\201C';
content: "\201C";

font-size: 6em;
font-family: 'Roboto', serif;
margin-top: 0.10em;;
font-family: "Roboto", serif;
margin-top: 0.1em;
margin-left: -0.2em;

z-index: -1;
color: darken($white, 7%);
}

margin-top: $leading;
margin-bottom: $leading;
line-height: $leading;
color: $black;

cite {
&::before {
content: "— "
content: "— ";
}

font-style: italic;
font-size: .95em;
font-size: 0.95em;
color: $darkGrey;
}

}

pre {
Expand Down
4 changes: 2 additions & 2 deletions assets/scss/partials/_vars.scss
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
@import '_colors';
@import '_screenSizes';
@import "_colors";
@import "_screenSizes";

$navWidth: 100px;
$meatWidth: 28px;
Expand Down
18 changes: 16 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,18 @@
"description": "A minimal blog theme for Hugo",
"license": "MIT",
"scripts": {
"develop": "hugo server -s ./exampleSite/"
"develop": "hugo server -s ./exampleSite/",
"format": "prettier ./ --write"
},
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
},
"devDependencies": {
"husky": "^4.2.5",
"lint-staged": ">=10",
"prettier": "^2.0.5"
},
"browserslist": [
"last 2 version",
Expand All @@ -17,5 +28,8 @@
"hugo",
"blog",
"go"
]
],
"lint-staged": {
"*.{js,css,scss}": "prettier --write"
}
}
13 changes: 13 additions & 0 deletions prettier.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
module.exports = {
arrowParens: "avoid",
bracketSpacing: false,
endOfLine: "lf",
htmlWhitespaceSensitivity: "css",
printWidth: 80,
proseWrap: "always",
semi: true,
singleQuote: false,
tabWidth: 2,
trailingComma: "all",
useTabs: false,
};
Loading