search

statiqdev / Statiq.Framework

A flexible and extensible static content generation framework for .NET.
https://statiq.dev/framework
MIT License
425 stars 74 forks source link

Rename modules [feedback wanted] #19

Closed daveaglick closed 5 years ago

daveaglick commented 5 years ago

Since tons of other stuff is breaking in v3, I've started looking at other stuff that's been bothering me but that I'd normally just leave alone. This may be the one final opportunity to correct some of these nits.

One area I think could be improved is module names. It made sense for them to be as short as possible when we were scripting config files (at least that was the thinking), but since it'll be code-based with Intellisense in v3, maybe it's time to rethink that.

I'm considering going through modules and renaming them so they all follow the pattern [verb][noun]:

You get the idea. I'll generate a table we can point to that shows the old and new names for people porting custom configs.

Thoughts? cc @deanebarker because I know you had some opinions on this a while back.

deanebarker commented 5 years ago

I absolutely believe in the verb-noun format. State (1) what you do, and (2) the thing you do it to.

I whole-heartedly endorse this plan.

LokiMidgard commented 5 years ago

I'll think it is a good idea. Especially If could makes problems in Visual Studio's if-snippet. SetContent is also easier to understand what it does then Content. đź‘Ť

johanvergeer commented 5 years ago

This looks like a great idea. You have my blessing. đź‘Ť

“Clean code is simple and direct. Clean code reads like well-written prose. Clean code never obscures the designer’s intent but rather is full of crisp abstractions and straightforward lines of control.

  • Grady Booch author of Object Oriented Analysis and Design with Applications”
daveaglick commented 5 years ago

Here's a mapping of existing module names to new ones for reference (I'll edit this comment as I figure out what the new names should be):