Skip to content

Commit

Permalink
Add the Plank project URL to the file comment header (#232)
Browse files Browse the repository at this point in the history
This makes it a bit clearer what Plank is, especially for random
developers who come across these files.

Also, remove some unused date-formatting code.
  • Loading branch information
jparise authored and rahul-malik committed Aug 16, 2019
1 parent 4c794b2 commit 6253078
Show file tree
Hide file tree
Showing 35 changed files with 35 additions and 40 deletions.
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/Board.m
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Board.m
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/Everything.m
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Everything.m
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/Image.m
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Image.m
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/Model.m
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Model.m
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/Pin.m
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Pin.m
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/PlankModelRuntime.m
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// PlankModelRuntime.m
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/User.m
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// User.m
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/VariableSubtitution.m
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// VariableSubtitution.m
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/include/Board.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Board.h
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/include/Everything.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Everything.h
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/include/Image.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Image.h
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/include/Model.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Model.h
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/include/Pin.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Pin.h
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// PlankModelRuntime.h
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Cocoa/Sources/Objective_C/include/User.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// User.h
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// VariableSubtitution.h
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/JS/flow/BoardType.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// @flow
//
// BoardType.js
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/JS/flow/EverythingType.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// @flow
//
// EverythingType.js
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/JS/flow/ImageType.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// @flow
//
// ImageType.js
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/JS/flow/ModelType.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// @flow
//
// ModelType.js
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/JS/flow/PinType.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// @flow
//
// PinType.js
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/JS/flow/UserType.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// @flow
//
// UserType.js
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/JS/flow/VariableSubtitutionType.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// @flow
//
// VariableSubtitutionType.js
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/JS/flow/runtime.flow.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// @flow
//
// runtime.flow.js
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Java/Sources/Board.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Board.java
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Java/Sources/Everything.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Everything.java
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Java/Sources/Image.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Image.java
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Java/Sources/Model.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Model.java
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Java/Sources/Pin.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// Pin.java
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Java/Sources/User.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// User.java
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
2 changes: 1 addition & 1 deletion Examples/Java/Sources/VariableSubtitution.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// VariableSubtitution.java
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down
7 changes: 1 addition & 6 deletions Sources/Core/FileGenerator.swift
Original file line number Diff line number Diff line change
Expand Up @@ -397,17 +397,12 @@ extension Dictionary where Value: ExpressibleByStringLiteral {

extension FileGenerator {
func renderCommentHeader() -> String {
formatter.dateStyle = DateFormatter.Style.long
formatter.timeStyle = .medium
formatter.timeZone = TimeZone(identifier: "UTC")
formatter.dateFormat = "MM-dd-yyyy 'at' HH:mm:ss"

var copy = self

let header = [
"//",
"// \(copy.fileName)",
"// Autogenerated by plank",
"// Autogenerated by Plank (https://pinterest.github.io/plank/)",
"//",
"// DO NOT EDIT - EDITS WILL BE OVERWRITTEN",
"// @generated",
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/JSFileGenerator.swift
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ extension JSModelFile {
"// @flow",
"//",
"// \(self.fileName)",
"// Autogenerated by plank",
"// Autogenerated by Plank (https://pinterest.github.io/plank/)",
"//",
"// DO NOT EDIT - EDITS WILL BE OVERWRITTEN",
"// @generated",
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/JSRuntimeFile.swift
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ extension JSRuntimeFile {
"// @flow",
"//",
"// \(self.fileName)",
"// Autogenerated by plank",
"// Autogenerated by Plank (https://pinterest.github.io/plank/)",
"//",
"// DO NOT EDIT - EDITS WILL BE OVERWRITTEN",
"// @generated",
Expand Down
2 changes: 1 addition & 1 deletion docs/_posts/2017-02-14-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ Now we can view our files and integrate them into our project. Here is the heade

<pre><code class="objc">//
// PDKUser.h
// Autogenerated by plank
// Autogenerated by Plank (https://pinterest.github.io/plank/)
//
// DO NOT EDIT - EDITS WILL BE OVERWRITTEN
// @generated
Expand Down

0 comments on commit 6253078

Please sign in to comment.