[1.0] Change directory structure #802

fabien0102 · 2017-04-14T19:55:34Z

Since I'm working on my starter with typescript (not working for instant, but I progress) I made some refactors and improvements:

Use redux for program.extensions
Fix some path on windows (I finded new one in the redux dev tool XD)
Some refactors like use const {program, config} = store.getState() to improve readability
Add a warn for install packages on windows (my mystery with sharp build resolve)

[Update] Finally, we decide to change directory structure to: (#814 (comment))

├── .cache // Stuff gets cached here. Shouldn't be under source control.
├── README.md
├── data // dump images, json, csv, yaml, etc. here.
├── gatsby-config.js
├── gatsby-node.js
├── plugins // Additional site-specific plugins
├── src // Everything related to the frontend goes here.
│   ├── components
│   │   └── header.js
|   ├── css
│         └── prism-coy.css
│   ├── html.js
│   ├── layouts
│   │   └── index.js
│   ├── pages
│   ├── templates
│   │   └── blog-post.js
│   └── utils
│       └── typography.js
├── static // Everything in this directory gets copied directly into public
├── public // Output directory

gatsbybot · 2017-04-14T20:02:53Z

Deploy preview ready!

Built with commit 04a8508

https://deploy-preview-802--gatsbyjs.netlify.com

gatsbybot · 2017-04-14T20:04:17Z

Deploy preview ready!

Built with commit 04a8508

https://deploy-preview-802--gatsbygram.netlify.com

KyleAMathews

Hey! Another great PR. Love refactoring page extensions to use Redux plus the other small fixes.

Let's not allow people to change the rootPath. First webpack/babel sometimes have trouble if they're processing files that are in different file directories. Second it seems to be a pointless option. What benefit is there to being able to change the root directory? A general rule for products is avoid all options unless they're absolutely necessary and I don't see setting rootPath to be absolutely necessary.

KyleAMathews · 2017-04-14T21:43:53Z

docs/docs/gatsby-on-windows.md

+
+## Installing dependencies without troubles.
+
+Even if you love using a pretty terminal as [hyper](https://hyper.is/) with a git bash,


no need to mention hyper here... Hyper is great but it's irrelevant to using Gatsby. My preferred "voice" for documentation is a "helpful, focused, and neutral".

Ok ;) It's noted, I will correct this

fabien0102 · 2017-04-15T08:23:12Z

I understand your point with rootPath, personnaly I don't like to my mixed sources files and my build tools (old habits). You can have a look on https://github.com/fabien0102/gatsby-starter to see my files structures (I got the folder templates that I don't want to mix with my sources file), this rootPath just move the html.* and layouts/default.* so I don't really see the issue with webpack/babel… (maybe rootPath it's not the correct name for this option, I try many names, maybe it's will be better with htmlPath and LayoutsPath ?)

So three options:

I remove this rootPath and mixed my sources file
I split rootPath into htmlPath and LayoutsPath
I keep this like this
Another proposition? (I know, I said 3 options)

KyleAMathews · 2017-04-15T15:57:43Z

docs/docs/gatsby-on-windows.md

@@ -16,3 +16,7 @@ powershell console. On installing this package, it downloads and installs the
 Visual C++ Build Tools 2015, provided free of charge by Microsoft. These tools
 are required to compile popular native modules. It will also install Python
 2.7, configuring your machine and npm appropriately.
+
+## Installing dependencies without troubles.


Is there some pages discussing this issue that you can link to?

Just my personal experience for instant, but I can search ;)

Looks like this is what you need to do to get Hyper setup vercel/hyper#946 (comment)

Perhaps just add this to the instructions instead of this section?

KyleAMathews · 2017-04-15T16:00:26Z

packages/gatsby-link/README.md

  </div>
 }
 ```
+
+In typescript:


This Typescript example is superfluous. It's 95% identical to the JS one and anyone writing Typescript would know how to translate the JS example to Typescript.

I can see value in maintaining code samples in different languages in the future but if we do, we'd want to put them in a toggleable interface so it's hiding the languages you're not interested in.

No problem, it was just a proposition ;)

KyleAMathews · 2017-04-15T16:07:06Z

The problem isn't with moving js files into a deeper directory—it's if you move it out of the file tree into a different file tree e.g. the path to html.js from the root is ../src-dir/html.js. That's when Babel/webpack fritz.

I'll think more about the idea of letting people move their files into a deeper directory ala your src directory. That could work fine.

More info: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode

fabien0102 · 2017-04-15T17:16:17Z

I got a last issue on the build process and I will add some validation on the rootPath option to avoid the case of ../src-dir (typescript really don't like when all my files are on the root…)

fabien0102 · 2017-04-17T14:29:23Z

All is working!

My test list:

www/ develop
www/ build
gatsbygram with sources into /src develop
gatsbygram with sources into /src build

[Edit] Arf my typescript starter as a last conflict between tsconfig/webpack but it's works for others projects without typescript ^^

…ugin Fix gatsbyjs#811

KyleAMathews · 2017-04-17T16:58:49Z

.vscode/settings.json

@@ -0,0 +1,6 @@
+// Placez vos paramètres dans ce fichier pour remplacer les paramètres par défaut et les paramètres utilisateur.


Let's stick with english here :-)

Daim! It's the auto-comment of my editor ^^

KyleAMathews · 2017-04-17T17:06:00Z

packages/gatsby/lib/bootstrap/index.js

@@ -90,17 +91,20 @@ module.exports = async (program: any) => {

  // Try opening the site's gatsby-config.js file.
  console.time(`open and validate gatsby-config.js`)
-  let config = {}
+  let config = {


Let's put defaults in Redux so data processing is centralized there.

This configuration works with basics configuration and with a custom `rootPath` (even with a typescript stack) It was tested with build and develop commands

KyleAMathews · 2017-04-18T20:23:03Z

packages/gatsby/lib/utils/webpack.config.js

      // Then in the special directory of isomorphic modules Gatsby ships with.
-      root: [directory, path.resolve(__dirname, `..`, `isomorphic`)],
+      root: [


Please revert this. I don't want multiple roots as in practice this is quite confusing. Just src should be a root now.

Actually I'll just merge this and then make the change.

KyleAMathews · 2017-04-18T20:49:29Z

And thanks again for all the work here! Really nice PR!

* Add a note on windows installation * Add missing dependencies into gatsby-plugin-typescript doc * Make HTMLPath configurable * Fix dev-cli readme * Use redux to managed program.extensions * Slashify all paths * Fix relativePath and clean no-used var * Get program.extensions from redux * Add a rootPath config * Some refactors * Run yarn format * Deal with config.rootPath for default layout * Fix bad rebase * Fix documention style * Add typescript definition for gatsby-link * Remove superfluous typescript example * Add vscode config to execute prettier on save More info: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode * Imprive joi validation on rootPath * Remove useless tsconfig.json * Remove unused var * Use program from redux * Improve rootPath config (default config and regex validator) * Ensure schema is created even if the project hasn't got any source plugin Fix gatsbyjs#811 * Find a webpack config that deals with all env \o/ This configuration works with basics configuration and with a custom `rootPath` (even with a typescript stack) It was tested with build and develop commands * Move default config into redux * Take english version to vscode/settings comment * Add some unit-test for `rootPath` * Make `src` as default rootPath * Rename `intermediate-representation` to `cache` * Add `public` into webpack root entries * Ignore .cache folders * Refactor `www` project with the new file directory * Refactor gatsbygram project with the new file directory

fabien0102 added 13 commits April 14, 2017 20:47

Add a note on windows installation

ad3e387

Add missing dependencies into gatsby-plugin-typescript doc

9834943

Make HTMLPath configurable

e3c4245

Fix dev-cli readme

1f999dd

Use redux to managed program.extensions

f45a455

Slashify all paths

abb0351

Fix relativePath and clean no-used var

3af80ea

Get program.extensions from redux

240f5da

Add a rootPath config

72e706f

Some refactors

d73cda5

Run yarn format

871d31c

Deal with config.rootPath for default layout

0c71ab9

Fix bad rebase

2de4528

KyleAMathews reviewed Apr 14, 2017

View reviewed changes

fabien0102 added 3 commits April 15, 2017 10:28

Fix documention style

f4b80ed

Merge remote-tracking branch 'upstream/1.0' into 1.0-typescript-support

186ed2b

Add typescript definition for gatsby-link

c8ee94b

KyleAMathews reviewed Apr 15, 2017

View reviewed changes

fabien0102 added 2 commits April 15, 2017 18:18

Remove superfluous typescript example

d3c99a3

Add vscode config to execute prettier on save

5501d78

More info: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode

fabien0102 added 4 commits April 15, 2017 20:00

Imprive joi validation on rootPath

55d14b8

Remove useless tsconfig.json

e85fe81

Remove unused var

3d3ce81

Use program from redux

7c58180

Improve rootPath config (default config and regex validator)

d232690

Ensure schema is created even if the project hasn't got any source pl…

7d1f719

…ugin Fix gatsbyjs#811

KyleAMathews reviewed Apr 17, 2017

View reviewed changes

fabien0102 added 5 commits April 17, 2017 19:39

Find a webpack config that deals with all env \o/

9886ac0

This configuration works with basics configuration and with a custom `rootPath` (even with a typescript stack) It was tested with build and develop commands

Move default config into redux

297100e

Take english version to vscode/settings comment

3df19af

Merge remote-tracking branch 'upstream/1.0' into 1.0-typescript-support

5c87433

Add some unit-test for rootPath

c913534

KyleAMathews mentioned this pull request Apr 17, 2017

Having a src directory as the root of all source files #814

Closed

fabien0102 changed the title ~~[1.0] Optional rootPath & some refactors~~ [1.0] Change directory structure Apr 18, 2017

fabien0102 changed the title ~~[1.0] Change directory structure~~ [1.0] [WIP] Change directory structure Apr 18, 2017

fabien0102 added 6 commits April 18, 2017 10:50

Make src as default rootPath

b3dd006

Rename intermediate-representation to cache

ad073ef

Add public into webpack root entries

e43b022

Ignore .cache folders

46c6b0f

Refactor www project with the new file directory

9aad264

Refactor gatsbygram project with the new file directory

04a8508

fabien0102 changed the title ~~[1.0] [WIP] Change directory structure~~ [1.0] Change directory structure Apr 18, 2017

fabien0102 mentioned this pull request Apr 18, 2017

[1.0] Refactor data layer #818

Merged

8 tasks

KyleAMathews reviewed Apr 18, 2017

View reviewed changes

KyleAMathews merged commit 718e22a into gatsbyjs:1.0 Apr 18, 2017

fabien0102 deleted the 1.0-typescript-support branch April 19, 2017 11:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[1.0] Change directory structure #802

[1.0] Change directory structure #802

fabien0102 commented Apr 14, 2017 •

edited

Loading

gatsbybot commented Apr 14, 2017 •

edited

Loading

gatsbybot commented Apr 14, 2017 •

edited

Loading

KyleAMathews left a comment

KyleAMathews Apr 14, 2017

fabien0102 Apr 15, 2017

fabien0102 commented Apr 15, 2017

KyleAMathews Apr 15, 2017

fabien0102 Apr 15, 2017

KyleAMathews Apr 17, 2017

KyleAMathews Apr 15, 2017

fabien0102 Apr 15, 2017

KyleAMathews commented Apr 15, 2017

fabien0102 commented Apr 15, 2017

fabien0102 commented Apr 17, 2017 •

edited

Loading

KyleAMathews Apr 17, 2017

fabien0102 Apr 17, 2017

KyleAMathews Apr 17, 2017

KyleAMathews Apr 18, 2017

KyleAMathews Apr 18, 2017

KyleAMathews commented Apr 18, 2017


		## Installing dependencies without troubles.

		Even if you love using a pretty terminal as [hyper](https://hyper.is/) with a git bash,

		@@ -0,0 +1,6 @@
		// Placez vos paramètres dans ce fichier pour remplacer les paramètres par défaut et les paramètres utilisateur.

[1.0] Change directory structure #802

[1.0] Change directory structure #802

Conversation

fabien0102 commented Apr 14, 2017 • edited Loading

gatsbybot commented Apr 14, 2017 • edited Loading

gatsbybot commented Apr 14, 2017 • edited Loading

KyleAMathews left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabien0102 commented Apr 15, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KyleAMathews commented Apr 15, 2017

fabien0102 commented Apr 15, 2017

fabien0102 commented Apr 17, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KyleAMathews commented Apr 18, 2017

fabien0102 commented Apr 14, 2017 •

edited

Loading

gatsbybot commented Apr 14, 2017 •

edited

Loading

gatsbybot commented Apr 14, 2017 •

edited

Loading

fabien0102 commented Apr 17, 2017 •

edited

Loading