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

refactor: filenames changed #796

Merged
merged 2 commits into from
Jul 11, 2024
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
4 changes: 2 additions & 2 deletions BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ load("@rules_cc//cc:defs.bzl", "cc_library")
genrule(
name = "generate_export_header",
srcs = [],
outs = ["include/faker-cxx/Export.h"],
outs = ["include/faker-cxx/export.h"],
cmd = """
echo "#pragma once" > $@
echo "#define FAKER_CXX_EXPORT" >> $@
Expand All @@ -13,7 +13,7 @@ genrule(
genrule(
name = "generate_version_header",
srcs = [],
outs = ["include/faker-cxx/Version.h"],
outs = ["include/faker-cxx/version.h"],
cmd = """
echo "#pragma once" > $@
echo '#define FAKER_CXX_VERSION_MAJOR 2' >> $@
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ Clang.

To properly use Faker C++ you must first consume the Faker library (see Consuming Library with CMake).
Once that is done, you need to include the proper [header](https://cieslarmichal.github.io/faker-cxx/files.html) file
depending on the module you wish to generate data from or use general include file `faker-cxx/Faker.h`.
depending on the module you wish to generate data from or use general include file `faker-cxx/faker.h`.
All the docs can be found [here](https://cieslarmichal.github.io/faker-cxx/).

Below is an example of how to use Faker C++ in your code.

```cpp
#include <iostream>

#include "faker-cxx/Faker.h" // or include specific module
#include "faker-cxx/faker.h" // or include specific module

int main()
{
Expand Down
2 changes: 1 addition & 1 deletion examples/basic/main.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#include <iostream>

#include "faker-cxx/Faker.h"
#include "faker-cxx/faker.h"

int main()
{
Expand Down
2 changes: 1 addition & 1 deletion examples/person/main.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#include <iostream>

#include "faker-cxx/Person.h"
#include "faker-cxx/person.h"

int main()
{
Expand Down
40 changes: 0 additions & 40 deletions include/faker-cxx/Faker.h

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::airline
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Animal.h → include/faker-cxx/animal.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::animal
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Book.h → include/faker-cxx/book.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::book
{
Expand Down
4 changes: 2 additions & 2 deletions include/faker-cxx/Color.h → include/faker-cxx/color.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

#include <string>

#include "types/Hex.h"
#include "faker-cxx/Export.h"
#include "types/hex.h"
#include "faker-cxx/export.h"

namespace faker::color
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::commerce
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::company
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::computer
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Crypto.h → include/faker-cxx/crypto.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

#include <optional>
#include <string>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::crypto
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::database
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once

#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::datatype
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Date.h → include/faker-cxx/date.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::date
{
Expand Down
40 changes: 40 additions & 0 deletions include/faker-cxx/faker.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
#pragma once

#include "faker-cxx/export.h"
#include "faker-cxx/airline.h"
#include "faker-cxx/animal.h"
#include "faker-cxx/book.h"
#include "faker-cxx/color.h"
#include "faker-cxx/commerce.h"
#include "faker-cxx/company.h"
#include "faker-cxx/computer.h"
#include "faker-cxx/crypto.h"
#include "faker-cxx/database.h"
#include "faker-cxx/datatype.h"
#include "faker-cxx/date.h"
#include "faker-cxx/finance.h"
#include "faker-cxx/food.h"
#include "faker-cxx/git.h"
#include "faker-cxx/hacker.h"
#include "faker-cxx/helper.h"
#include "faker-cxx/image.h"
#include "faker-cxx/internet.h"
#include "faker-cxx/location.h"
#include "faker-cxx/lorem.h"
#include "faker-cxx/medicine.h"
#include "faker-cxx/movie.h"
#include "faker-cxx/music.h"
#include "faker-cxx/number.h"
#include "faker-cxx/person.h"
#include "faker-cxx/phone.h"
#include "faker-cxx/plant.h"
#include "faker-cxx/random_generator.h"
#include "faker-cxx/science.h"
#include "faker-cxx/sport.h"
#include "faker-cxx/string.h"
#include "faker-cxx/system.h"
#include "faker-cxx/vehicle.h"
#include "faker-cxx/version.h"
#include "faker-cxx/video_game.h"
#include "faker-cxx/weather.h"
#include "faker-cxx/word.h"
6 changes: 3 additions & 3 deletions include/faker-cxx/Finance.h → include/faker-cxx/finance.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
#include <string>
#include <string_view>

#include "faker-cxx/Export.h"
#include "types/Country.h"
#include "types/Precision.h"
#include "faker-cxx/export.h"
#include "types/country.h"
#include "types/precision.h"

namespace faker::finance
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Food.h → include/faker-cxx/food.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::food
{
Expand Down
4 changes: 2 additions & 2 deletions include/faker-cxx/Git.h → include/faker-cxx/git.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
#include <optional>
#include <string>

#include "faker-cxx/Export.h"
#include "faker-cxx/types/Country.h"
#include "faker-cxx/export.h"
#include "faker-cxx/types/country.h"

namespace faker::git
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Hacker.h → include/faker-cxx/hacker.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::hacker
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Helper.h → include/faker-cxx/helper.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#include <span>
#include <vector>

#include "Number.h"
#include "number.h"

namespace faker::helper
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Image.h → include/faker-cxx/image.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

#include <optional>
#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::image
{
Expand Down
4 changes: 2 additions & 2 deletions include/faker-cxx/Internet.h → include/faker-cxx/internet.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
#include <string>
#include <string_view>

#include "faker-cxx/Export.h"
#include "types/Country.h"
#include "faker-cxx/export.h"
#include "types/country.h"

namespace faker::internet
{
Expand Down
4 changes: 2 additions & 2 deletions include/faker-cxx/Location.h → include/faker-cxx/location.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

#include <string_view>

#include "faker-cxx/Export.h"
#include "types/Precision.h"
#include "faker-cxx/export.h"
#include "types/precision.h"

namespace faker::location
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Lorem.h → include/faker-cxx/lorem.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::lorem
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::medicine
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Movie.h → include/faker-cxx/movie.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::movie
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Music.h → include/faker-cxx/music.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::music
{
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions include/faker-cxx/Person.h → include/faker-cxx/person.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
#include <optional>
#include <string_view>

#include "faker-cxx/Export.h"
#include "types/Country.h"
#include "faker-cxx/export.h"
#include "types/country.h"

namespace faker::person
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Phone.h → include/faker-cxx/phone.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#include <string>
#include <string_view>
#include <unordered_map>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::phone
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Plant.h → include/faker-cxx/plant.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::plant
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::science
{
Expand Down
2 changes: 1 addition & 1 deletion include/faker-cxx/Sport.h → include/faker-cxx/sport.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#pragma once

#include <string_view>
#include "faker-cxx/Export.h"
#include "faker-cxx/export.h"

namespace faker::sport
{
Expand Down
Loading
Loading